<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
<html><head>












 










 
 
 

 

  




  
    
<meta http-equiv="content-type" content="text/html; charset=utf-8"><title>Gadgets API Reference - OpenSocial - Google Code</title>

<script type="text/javascript">
(function(){function a(){this.t={};this.tick=function(c){this.t[c]=(new Date).getTime()};this.tick("start")}var b=new a;window.jstiming={Timer:a,load:b};if(window.external&&window.external.pageT)window.jstiming.pt=window.external.pageT;})();

var _tocPath_ = '/html/apis/opensocial/docs/_toc.ezt';
</script>
<link href="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/codesite.css" type="text/css" rel="stylesheet">
<script src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/codesite.js" type="text/javascript"></script>
<link rel="search" type="application/opensearchdescription+xml" title="Google Code" href="http://code.google.com/osd.xml"><!--[if IE]><link rel="stylesheet" type="text/css" href="/css/iehacks.css" /><![endif]--></head><body class="gc-documentation">

    
    
    <div id="gc-container">
<a name="top"></a>
<div id="skipto">
  <a href="#gc-pagecontent">Skip to page content</a>
  <a href="#gc-toc">Skip to main navigation</a>
</div>
<div id="langpref">    
   <a style="text-decoration: none; cursor: pointer;" class="dropdown" href="http://code.google.com/"><span class="title1219980456234" style="text-decoration: underline;">English</span><span style="vertical-align: middle; text-decoration: none; font-family: arial,sans-serif; font-size: 11px;">&nbsp;▼</span></a>
   <span>|</span>
   <a href="http://code.google.com/more/">Site Directory</a>
</div>
<div id="gc-header">
  <div id="logo"><a href="http://code.google.com/">
  
     <img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Google Code Home Page" id="gc-logo-img" height="1" width="1">
  
  </a></div>
  <div id="search">
    <div id="searchForm" class="searchForm" style="">
      <form action="" accept-charset="utf-8" class="gsc-search-box" onsubmit="executeGSearch(document.getElementById('gsearchInput').value); return false;">
        <table class="gsc-search-box" cellpadding="0" cellspacing="0">
          <tbody>
            <tr>
              <td class="gsc-input">
                <input id="gsearchInput" name="q" maxlength="2048" class="gsc-input" autocomplete="off" title="Google Code Search" style="width: 345px;" type="text">
              </td>
              <td class="gsc-search-button">
                <div id="cs-searchresults" onclick="event.cancelBubble = true;"></div>
                <input title="Search" id="gsearchButton" class="gsc-search-button" value="Search" type="submit">
              </td>
            </tr>
            <tr>
              <td class="greytext">e.g. "ajax apis" or "open source"</td>
            </tr>
          </tbody>
        </table>
      </form>
    </div> <!-- end searchForm -->
    <div id="searchForm2" class="searchForm2" style="display: none;">
      <form id="cse" action="http://www.google.com/cse">
        <input name="cref" value="http://code.google.com/cse/googlecode-context.xml" type="hidden">
        <input name="q" maxlength="2048" autocomplete="off" title="Google Code Search" style="width: 345px;" type="text">
        <input name="sa" value="Search" title="Search" type="submit"><br>
        <div class="greytext">e.g. "ajax apis" or "open source"</div>
      </form>
    </div> <!-- end searchForm2 -->
  </div> <!-- end search -->
</div> <!-- end gc-header -->


<div id="codesiteContent">

<a name="gc-topnav-anchor"></a>
<div id="gc-topnav">
  <h1>OpenSocial</h1>
  <ul id="docs" class="gc-topnav-tabs">

    <li id="home_link">
      <a href="http://code.google.com/apis/opensocial/" title="OpenSocial home page">Home</a>
    </li>
  
    <li id="docs_link">
      <a href="http://code.google.com/apis/opensocial/docs/index.html" class="selected" title="Official OpenSocial documentation">Docs</a>
    </li>
  
    <li id="faq_link">
      <a href="http://code.google.com/apis/opensocial/faq.html" title="Answers to frequently asked questions about OpenSocial">FAQ</a>
    </li>
  
    <li id="articles_link">
      <a href="http://code.google.com/apis/opensocial/articles/" title="Focused articles and tutorials for OpenSocial developers">Articles</a>
    </li>
  
    <li>
      <a href="http://opensocialapis.blogspot.com/" title="Official OpenSocial blog">Blog</a>
    </li>
  
    <li>
      <a href="http://groups.google.com/group/opensocial" title="OpenSocial developer forum">Group</a>
    </li>
  
    <li>
      <a href="http://code.google.com/apis/opensocial/terms.html" title="OpenSocial terms of service">Terms</a>
    </li>
  

  </ul>
</div> <!-- end gc-topnav -->

    <div class="g-section g-tpl-210">

      <a name="gc-toc"></a>  
      <div class="g-unit g-first" id="gc-toc">
          <ul class="treelist tlw-nested-only tlw-processed tlw-instance-0">
    <li><a href="http://code.google.com/apis/opensocial/partners.html">Who's Using It?</a></li>
    <li><a href="http://code.google.com/apis/opensocial/gettingstarted.html">Building Social Apps</a></li>
    <li><a href="http://code.google.com/apis/opensocial/container.html">Hosting OpenSocial Apps</a></li>
  </ul>

<div class="line"></div>

<ul class="treelist tlw-nested-only tlw-processed tlw-instance-1">
  <li><h1 class="tlw-ignore">JavaScript API</h1>
    <ul>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/devguide.html">Developer's Guide (v0.7)</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/releasenotes.html">Release Notes (v0.8)</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/spec.html">API Specification (v0.8)</a></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Collapse API Reference (v0.8)"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Collapse API Reference (v0.8)" class="tlw-control tlw-minus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/">API Reference (v0.8)</a></div><ul style="display: block;" id="1-sub-0">
     <!-- _sidenav.ezt doesn't work with the current scripts. Shakila is working on it. -->
      
<ul>
<li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Collapse opensocial"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Collapse opensocial" class="tlw-control tlw-minus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial">opensocial</a></div><ul style="display: block;" id="1-sub-1">
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Activity"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Activity" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Activity">Activity</a></div><ul style="display: none;" id="1-sub-2">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Activity.Field">Field</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Address"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Address" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Address">Address</a></div><ul style="display: none;" id="1-sub-3">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Address.Field">Field</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand BodyType"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand BodyType" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.BodyType">BodyType</a></div><ul style="display: none;" id="1-sub-4">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.BodyType.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Collection">Collection</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.CreateActivityPriority">CreateActivityPriority</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand DataRequest"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand DataRequest" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest">DataRequest</a></div><ul style="display: none;" id="1-sub-5">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.DataRequestFields">DataRequestFields</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.FilterType">FilterType</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.PeopleRequestFields">PeopleRequestFields</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.SortOrder">SortOrder</a>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataResponse">DataResponse</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Email"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Email" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Email">Email</a></div><ul style="display: none;" id="1-sub-6">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Email.Field">Field</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Enum"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Enum" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Enum">Enum</a></div><ul style="display: none;" id="1-sub-7">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Enum.Drinker">Drinker</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Enum.Gender">Gender</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Enum.LookingFor">LookingFor</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Enum.Presence">Presence</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Enum.Smoker">Smoker</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Environment"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Environment" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Environment">Environment</a></div><ul style="display: none;" id="1-sub-8">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Environment.ObjectType">ObjectType</a>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.EscapeType">EscapeType</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand IdSpec"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand IdSpec" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.IdSpec">IdSpec</a></div><ul style="display: none;" id="1-sub-9">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.IdSpec.Field">Field</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.IdSpec.PersonId">PersonId</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand MediaItem"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand MediaItem" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.MediaItem">MediaItem</a></div><ul style="display: none;" id="1-sub-10">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.MediaItem.Field">Field</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.MediaItem.Type">Type</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Message"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Message" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Message">Message</a></div><ul style="display: none;" id="1-sub-11">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Message.Field">Field</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Message.Type">Type</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Name"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Name" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Name">Name</a></div><ul style="display: none;" id="1-sub-12">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Name.Field">Field</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand NavigationParameters"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand NavigationParameters" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.NavigationParameters">NavigationParameters</a></div><ul style="display: none;" id="1-sub-13">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.NavigationParameters.DestinationType">DestinationType</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.NavigationParameters.Field">Field</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Organization"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Organization" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Organization">Organization</a></div><ul style="display: none;" id="1-sub-14">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Organization.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Permission">Permission</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Person"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Person" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Person">Person</a></div><ul style="display: none;" id="1-sub-15">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Person.Field">Field</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Phone"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Phone" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Phone">Phone</a></div><ul style="display: none;" id="1-sub-16">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Phone.Field">Field</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand ResponseItem"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand ResponseItem" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.ResponseItem">ResponseItem</a></div><ul style="display: none;" id="1-sub-17">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.ResponseItem.Error">Error</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Url"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Url" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Url">Url</a></div><ul style="display: none;" id="1-sub-18">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Url.Field">Field</a>
  </li>
</ul>
  </li>
</ul>
</li>
</ul>

 

     <!-- Until that's fixed, we include _all_classes.ezt instead. -->
     <!--    
<ul>
<li><a href="#opensocial">opensocial</a>
<ul>
  <li><a href="#opensocial.Activity">Activity</a>
<ul>
  <li><a href="#opensocial.Activity.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Address">Address</a>
<ul>
  <li><a href="#opensocial.Address.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.BodyType">BodyType</a>
<ul>
  <li><a href="#opensocial.BodyType.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Collection">Collection</a>
  </li>
  <li><a href="#opensocial.CreateActivityPriority">CreateActivityPriority</a>
  </li>
  <li><a href="#opensocial.DataRequest">DataRequest</a>
<ul>
  <li><a href="#opensocial.DataRequest.DataRequestFields">DataRequestFields</a>
  </li>
  <li><a href="#opensocial.DataRequest.FilterType">FilterType</a>
  </li>
  <li><a href="#opensocial.DataRequest.PeopleRequestFields">PeopleRequestFields</a>
  </li>
  <li><a href="#opensocial.DataRequest.SortOrder">SortOrder</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.DataResponse">DataResponse</a>
  </li>
  <li><a href="#opensocial.Email">Email</a>
<ul>
  <li><a href="#opensocial.Email.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Enum">Enum</a>
<ul>
  <li><a href="#opensocial.Enum.Drinker">Drinker</a>
  </li>
  <li><a href="#opensocial.Enum.Gender">Gender</a>
  </li>
  <li><a href="#opensocial.Enum.LookingFor">LookingFor</a>
  </li>
  <li><a href="#opensocial.Enum.Presence">Presence</a>
  </li>
  <li><a href="#opensocial.Enum.Smoker">Smoker</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Environment">Environment</a>
<ul>
  <li><a href="#opensocial.Environment.ObjectType">ObjectType</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.EscapeType">EscapeType</a>
  </li>
  <li><a href="#opensocial.IdSpec">IdSpec</a>
<ul>
  <li><a href="#opensocial.IdSpec.Field">Field</a>
  </li>
  <li><a href="#opensocial.IdSpec.PersonId">PersonId</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.MediaItem">MediaItem</a>
<ul>
  <li><a href="#opensocial.MediaItem.Field">Field</a>
  </li>
  <li><a href="#opensocial.MediaItem.Type">Type</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Message">Message</a>
<ul>
  <li><a href="#opensocial.Message.Field">Field</a>
  </li>
  <li><a href="#opensocial.Message.Type">Type</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Name">Name</a>
<ul>
  <li><a href="#opensocial.Name.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.NavigationParameters">NavigationParameters</a>
<ul>
  <li><a href="#opensocial.NavigationParameters.DestinationType">DestinationType</a>
  </li>
  <li><a href="#opensocial.NavigationParameters.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Organization">Organization</a>
<ul>
  <li><a href="#opensocial.Organization.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Permission">Permission</a>
  </li>
  <li><a href="#opensocial.Person">Person</a>
<ul>
  <li><a href="#opensocial.Person.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Phone">Phone</a>
<ul>
  <li><a href="#opensocial.Phone.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.ResponseItem">ResponseItem</a>
<ul>
  <li><a href="#opensocial.ResponseItem.Error">Error</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Url">Url</a>
<ul>
  <li><a href="#opensocial.Url.Field">Field</a>
  </li>
</ul>
  </li>
</ul>
</li>
</ul>

 -->

     <!-- The following line is obsolete because (a) we don't include _all_classes.ezt -->
     <!-- any more, and (b) the extra tag in _all_classes.ezt has been fixed anyway. -->
     <!--     </ul></li>  -->
          <li style="padding-top: 0pt; padding-bottom: 0pt;"> 
              <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand gadgets (core)"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand gadgets (core)" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#core">gadgets (core)</a></div><ul style="display: none;" id="1-sub-19">
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.Prefs">Prefs</a></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand io"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand io" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io">io</a></div><ul style="display: none;" id="1-sub-20">
          <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io.AuthorizationType">AuthorizationType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io.ContentType">ContentType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io.MethodType">MethodType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io.ProxyUrlRequestParameters">ProxyUrlRequestParameters</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io.RequestParameters">RequestParameters</a></li>
        </ul>
      </li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.json">json</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.util">util</a></li>
    </ul>


          </li>
          <li style="padding-top: 0pt; padding-bottom: 0pt;"> 
              <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand gadgets (feature-specific)"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand gadgets (feature-specific)" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#features">gadgets (feature-specific)</a></div><ul style="display: none;" id="1-sub-21">
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.MiniMessage">MiniMessage</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.Tab">Tab</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.TabSet">TabSet</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.flash">flash</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.pubsub">pubsub</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.rpc">rpc</a></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;"> <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand skins"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand skins" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.skins">skins</a></div><ul style="display: none;" id="1-sub-22">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.skins.Property">Property</a></li>
      </ul></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;"> <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand views"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand views" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.views">views</a></div><ul style="display: none;" id="1-sub-23">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.views.View">View</a></li>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.views.ViewType">ViewType</a></li>
      </ul></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.window">window</a></li>
    </ul>

          </li>
        </ul>
      </li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Previous Versions"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Previous Versions" class="tlw-control tlw-plus"></a><span class="tlw-title">Previous Versions</span></div><ul style="display: none;" id="1-sub-62">
        <li style="padding-top: 0pt; padding-bottom: 0pt;">
          <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Version 0.7"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Version 0.7" class="tlw-control tlw-plus"></a><span class="tlw-title">Version 0.7</span></div><ul style="display: none;" id="1-sub-63">
            <li><a href="http://code.google.com/apis/opensocial/docs/0.7/devguide.html">Developer's Guide</a></li>
            <li><a href="http://code.google.com/apis/opensocial/docs/0.7/spec.html">API Specification</a></li>
            <li style="padding-top: 0pt; padding-bottom: 0pt;">
              <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand API Reference"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand API Reference" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/">API Reference</a></div><ul style="display: none;" id="1-sub-24">
                


<li style="padding-top: 0pt; padding-bottom: 0pt;">
  <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand opensocial"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand opensocial" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.html">opensocial</a></div><ul style="display: none;" id="1-sub-25">
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Activity"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Activity" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Activity.html">Activity</a></div><ul style="display: none;" id="1-sub-26">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Activity.Field.html">Field</a></li>
        <li style="padding-top: 0pt; padding-bottom: 0pt;">
          <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand MediaItem"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand MediaItem" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Activity.MediaItem.html">MediaItem</a></div><ul style="display: none;" id="1-sub-27">
            <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Activity.MediaItem.Field.html">Field</a></li>
            <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Activity.MediaItem.Type.html">Type</a></li>
          </ul>
        </li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Address"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Address" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Address.html">Address</a></div><ul style="display: none;" id="1-sub-28">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Address.Field.html">Field</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand BodyType"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand BodyType" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.BodyType.html">BodyType</a></div><ul style="display: none;" id="1-sub-29">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.BodyType.Field.html">Field</a></li>
      </ul>
    </li>
    <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Collection.html">Collection</a></li>
    <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.CreateActivityPriority.html">CreateActivityPriority</a></li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand DataRequest"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand DataRequest" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.html">DataRequest</a></div><ul style="display: none;" id="1-sub-30">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.FilterType.html">FilterType</a></li>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.Group.html">Group</a></li>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.PeopleRequestFields.html">PeopleRequestFields</a></li>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.PersonId.html">PersonId</a></li>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.SortOrder.html">SortOrder</a></li>
      </ul>
    </li>
    <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataResponse.html">DataResponse</a></li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Email"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Email" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Email.html">Email</a></div><ul style="display: none;" id="1-sub-31">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Email.Field.html">Field</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Enum"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Enum" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Enum.html">Enum</a></div><ul style="display: none;" id="1-sub-32">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Enum.Drinker.html">Drinker</a></li>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Enum.Gender.html">Gender</a></li>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Enum.Smoker.html">Smoker</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Environment"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Environment" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Environment.html">Environment</a></div><ul style="display: none;" id="1-sub-33">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Environment.ObjectType.html">ObjectType</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Message"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Message" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Message.html">Message</a></div><ul style="display: none;" id="1-sub-34">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Message.Field.html">Field</a></li>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Message.Type.html">Type</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Name"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Name" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Name.html">Name</a></div><ul style="display: none;" id="1-sub-35">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Name.Field.html">Field</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Organization"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Organization" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Organization.html">Organization</a></div><ul style="display: none;" id="1-sub-36">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Organization.Field.html">Field</a></li>
      </ul>
    </li>
    <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Permission.html">Permission</a></li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Person"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Person" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Person.html">Person</a></div><ul style="display: none;" id="1-sub-37">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Person.Field.html">Field</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Phone"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Phone" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Phone.html">Phone</a></div><ul style="display: none;" id="1-sub-38">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Phone.Field.html">Field</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand ResponseItem"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand ResponseItem" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.ResponseItem.html">ResponseItem</a></div><ul style="display: none;" id="1-sub-39">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.ResponseItem.Error.html">Error</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Url"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Url" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Url.html">Url</a></div><ul style="display: none;" id="1-sub-40">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Url.Field.html">Field</a></li>
      </ul>
    </li>
  </ul>
</li>

                  <li style="padding-top: 0pt; padding-bottom: 0pt;">
    <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand gadgets (core)"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand gadgets (core)" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets_core.html">gadgets (core)</a></div><ul style="display: none;" id="1-sub-41">
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.Prefs.html">Prefs</a></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand io"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand io" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.io.html">io</a></div><ul style="display: none;" id="1-sub-42">
          <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.io.AuthorizationType.html">AuthorizationType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.io.ContentType.html">ContentType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.io.MethodType.html">MethodType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.io.RequestParameters.html">RequestParameters</a></li>
        </ul>
      </li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.json.html">json</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.util.html">util</a></li>
    </ul>
  </li>

                  <li style="padding-top: 0pt; padding-bottom: 0pt;">
    <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand gadgets (feature-specific)"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand gadgets (feature-specific)" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets_feature.html">gadgets (feature-specific)</a></div><ul style="display: none;" id="1-sub-43">
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.MiniMessage.html">MiniMessage</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.Tab.html">Tab</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.TabSet.html">TabSet</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.flash.html">flash</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.rpc.html">rpc</a></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand views"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand views" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.views.html">views</a></div><ul style="display: none;" id="1-sub-44">
          <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.views.View.html">View</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.views.ViewType.html">ViewType</a></li>
        </ul>
      </li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand skins"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand skins" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.skins.html">skins</a></div><ul style="display: none;" id="1-sub-45">
          <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.skins.Property.html">Property</a></li>
        </ul>
      </li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.window.html">window</a></li>
    </ul>
  </li>

              </ul>
            </li>
          </ul>
        </li>
        <li style="padding-top: 0pt; padding-bottom: 0pt;">
          <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Version 0.6"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Version 0.6" class="tlw-control tlw-plus"></a><span class="tlw-title">Version 0.6</span></div><ul style="display: none;" id="1-sub-64">
            <li><a href="http://code.google.com/apis/opensocial/docs/0.6/devguide.html">Developer's Guide</a></li>
            <li><a href="http://code.google.com/apis/opensocial/docs/0.6/spec.html">API Specification</a></li>
            <li style="padding-top: 0pt; padding-bottom: 0pt;">
              
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand API Reference"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand API Reference" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/">API Reference</a></div><ul style="display: none;" id="1-sub-46">    
 <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand opensocial"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand opensocial" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.html">opensocial</a></div><ul style="display: none;" id="1-sub-47">
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Activity"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Activity" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Activity.html">Activity</a></div><ul style="display: none;" id="1-sub-48">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Activity.Field.html">Field</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand MediaItem"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand MediaItem" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Activity.MediaItem.html">MediaItem</a></div><ul style="display: none;" id="1-sub-49">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Activity.MediaItem.Field.html">Field</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Activity.MediaItem.Type.html">Type</a>
  </li>
</ul>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Collection.html">Collection</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand ContentRequestParameters"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand ContentRequestParameters" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.ContentRequestParameters.html">ContentRequestParameters</a></div><ul style="display: none;" id="1-sub-50">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.ContentRequestParameters.AuthenticationType.html">AuthenticationType</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.ContentRequestParameters.ContentType.html">ContentType</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.ContentRequestParameters.MethodType.html">MethodType</a>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.CreateActivityPriority.html">CreateActivityPriority</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand DataRequest"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand DataRequest" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.DataRequest.html">DataRequest</a></div><ul style="display: none;" id="1-sub-51">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.DataRequest.ActivityRequestFields.html">ActivityRequestFields</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.DataRequest.FilterType.html">FilterType</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.DataRequest.Group.html">Group</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.DataRequest.PeopleRequestFields.html">PeopleRequestFields</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.DataRequest.PersonId.html">PersonId</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.DataRequest.SortOrder.html">SortOrder</a>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.DataResponse.html">DataResponse</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Environment"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Environment" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Environment.html">Environment</a></div><ul style="display: none;" id="1-sub-52">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Environment.ObjectType.html">ObjectType</a>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Permission.html">Permission</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Person"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Person" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Person.html">Person</a></div><ul style="display: none;" id="1-sub-53">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Person.Field.html">Field</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand ResponseItem"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand ResponseItem" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.ResponseItem.html">ResponseItem</a></div><ul style="display: none;" id="1-sub-54">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.ResponseItem.Error.html">Error</a>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Surface.html">Surface</a>
  </li>
</ul>
</li>

</ul>


            </li>
          </ul>
        </li>
          <li style="padding-top: 0pt; padding-bottom: 0pt;">
            <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Version 0.5"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Version 0.5" class="tlw-control tlw-plus"></a><span class="tlw-title">Version 0.5</span></div><ul style="display: none;" id="1-sub-65">
              <li><a href="http://code.google.com/apis/opensocial/docs/0.5/devguide.html">Developer's Guide</a></li>
              <li style="padding-top: 0pt; padding-bottom: 0pt;">
                
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand API Reference"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand API Reference" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/">API Reference</a></div><ul style="display: none;" id="1-sub-55">
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
    <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand opensocial"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand opensocial" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.html">opensocial</a></div><ul style="display: none;" id="1-sub-56">
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Activity"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Activity" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Activity.html">Activity</a></div><ul style="display: none;" id="1-sub-57">
	        <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Activity.Field.html">Field</a></li>
	        <li style="padding-top: 0pt; padding-bottom: 0pt;">
	          <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand MediaItem"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand MediaItem" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Activity.MediaItem.html">MediaItem</a></div><ul style="display: none;" id="1-sub-58">
              <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Activity.MediaItem.Field.html">Field</a></li>
              <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Activity.MediaItem.Type.html">Type</a></li>
            </ul> 
          </li> <!-- end MediaItem -->
        </ul>
      </li> <!-- end Activity -->
      <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Collection.html">Collection</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.CreateActivityPriority.html">CreateActivityPriority</a></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand DataRequest"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand DataRequest" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataRequest.html">DataRequest</a></div><ul style="display: none;" id="1-sub-59">
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataRequest.ActivityRequestFields.html">ActivityRequestFields</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataRequest.FilterType.html">FilterType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataRequest.Group.html">Group</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataRequest.PeopleRequestFields.html">PeopleRequestFields</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataRequest.PersonId.html">PersonId</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataRequest.ProfileDetailType.html">ProfileDetailType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataRequest.SortOrder.html">SortOrder</a></li>
        </ul> 
      </li> <!-- End DataRequest -->
      <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataResponse.html">DataResponse</a></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Person"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Person" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Person.html">Person</a></div><ul style="display: none;" id="1-sub-60">
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Person.Field.html">Field</a></li>
        </ul>
      </li> <!-- end Person -->
      <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.ResponseItem.html">ResponseItem</a></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Stream"><img src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/cleardot.gif" alt="Expand Stream" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Stream.html">Stream</a></div><ul style="display: none;" id="1-sub-61">
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Stream.Field.html">Field</a></li>
        </ul>
      </li> <!-- end Stream -->
    </ul>
  </li> <!-- end opensocial -->
</ul>


              </li>
            </ul>
          </li>
        </ul>
      </li>
    </ul>
  </li>
  <li><h1 class="tlw-ignore">RESTful API</h1>
    <ul>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/restfulspec.html">RESTful API Specification</a></li>
    </ul>
  </li>
  <li><h1 class="tlw-ignore">Other Resources</h1>
    <ul>
      <li><a href="http://code.google.com/apis/orkut/">Build apps for Orkut</a></li>
      <li><a href="http://code.google.com/apis/gadgets/docs/spec.html">Gadgets Specification</a></li>
    </ul>
  </li>
</ul>

      </div>
      
      <a name="gc-pagecontent"></a>   
      <div style="position: relative;" class="g-unit" id="gc-pagecontent">
        <h1 class="page_title">Gadgets API Reference</h1>


<p>
This document describes the classes and methods in the
<code>gadgets.*</code> namespace,
some of which are <em>feature-specific</em>.
For information on including features,
see the
<a href="http://code.google.com/apis/gadgets/docs/spec.html#corejavascriptapi">Gadgets Specification</a>.
</p>

<p class="note">
<b>Note:</b>
This API is not yet supported by the production instance of iGoogle,
though it is available in the
<a href="http://code.google.com/apis/igoogle/docs/gs.html">iGoogle sandbox</a>.
If you'd like to write a gadget for iGoogle,
see the
<a href="http://code.google.com/apis/gadgets/docs/reference.html">gadgets API Reference</a>.
</p>

<h4>Contents</h4>

<ul>
  <li><span class="tlw-title"><a href="#types">Type Conventions</a></span></li>
    <li><span class="tlw-title" id="core">Core API</span>
          <ul>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.Prefs">Prefs</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io">io</a>
        <ul>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io.AuthorizationType">AuthorizationType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io.ContentType">ContentType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io.MethodType">MethodType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io.ProxyUrlRequestParameters">ProxyUrlRequestParameters</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io.RequestParameters">RequestParameters</a></li>
        </ul>
      </li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.json">json</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.util">util</a></li>
    </ul>


    </li>
    <li><span class="tlw-title" id="features">Feature-Specific API</span>
          <ul>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.MiniMessage">MiniMessage</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.Tab">Tab</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.TabSet">TabSet</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.flash">flash</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.pubsub">pubsub</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.rpc">rpc</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.skins">skins</a> <ul>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.skins.Property">Property</a></li>
      </ul></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.views">views</a> <ul>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.views.View">View</a></li>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.views.ViewType">ViewType</a></li>
      </ul></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.window">window</a></li>
    </ul>

    </li>
</ul>


<p class="backtotop"><a href="#top">Back to top</a></p>
<h1 id="types">Type Conventions</h1>

<p>
This document uses the following conventions for types:
</p>

<dl>
<dt> Array&lt;T&gt; <em>or</em> Array.&lt;T&gt; </dt>
  <dd>An Array filled with only objects of type T.
      This convention is similar to Java generics. </dd>
<dt> Map&lt;K, V&gt; <em>or</em> Map.&lt;K, V&gt; </dt>
  <dd>A JavaScript object with keys of type K
     that map to values of type V.
     Again, this convention is similar to Java generics.
     It's often used for <em>opt_params</em> variables.</dd>
<dt>static</dt>
  <dd>A type marked with <em>static class</em>
      has no public or private constructor.
      In other words, the type is a namespace,
      not a class that can be instantiated to create objects.
      The fields and functions in such a type
      are also marked as <em>static</em>.
      </dd>
<dt> Boolean </dt>
  <dd>A boolean value (not a <code>Boolean</code> object).</dd>
<dt> String </dt>
  <dd>A string value (not a <code>String</code> object).</dd>
</dl>


<p class="backtotop"><a href="#top">Back to top</a></p>









<h1 id="gadgets.MiniMessage">Class gadgets.MiniMessage</h1>


<!-- <i>Defined in <a href="minimessage.src.html">minimessage.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.MiniMessage_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.MiniMessage_method_detail">DETAIL</a>  
</p>

<p>
MiniMessage class,
used to create messages that will appear to the user within the
    gadget.
Typical use cases:
</p><ul>
<li> Status messages — loading, saving, etc.
</li><li> Promotional messages — new features, new gadget, etc.
</li><li> Debug/error messages — bad input, failed connection to server, etc.
</li></ul>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<a name="gadgets.MiniMessage_constructor_summary"> </a>
<h2>Constructor Summary</h2>
<dl>

    <dt><code>
        <b><a href="#gadgets.MiniMessage">gadgets.MiniMessage</a></b>(opt_moduleId, opt_container)
        </code></dt>
    <dd>Creates a MiniMessage.</dd>

</dl>
&nbsp;
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="gadgets.MiniMessage_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>
    
<dt><code>
                &nbsp;HTMLElement
                
<b> <a href="#gadgets.MiniMessage.createDismissibleMessage">createDismissibleMessage</a></b>(message, opt_callback) </code> 
</dt>
<dd>Creates a dismissible message with an [x] icon that allows users to dismiss
the message.
</dd>

<dt><code>
                &nbsp;HTMLElement
                
<b> <a href="#gadgets.MiniMessage.createStaticMessage">createStaticMessage</a></b>(message) </code> 
</dt>
<dd>Creates a static message that can only be dismissed programmatically
(by calling dismissMessage()).
</dd>

<dt><code>
                &nbsp;HTMLElement
                
<b> <a href="#gadgets.MiniMessage.createTimerMessage">createTimerMessage</a></b>(message, seconds, opt_callback) </code> 
</dt>
<dd>Creates a message that displays for the specified number of seconds.
</dd>

<dt><code>
<b> <a href="#gadgets.MiniMessage.dismissMessage">dismissMessage</a></b>(message) </code> 
</dt>
<dd>Dismisses the specified message.
</dd>

</dl>
&nbsp;


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ========= CONSTRUCTOR DETAIL START ======== -->
<a name="gadgets.MiniMessage_constructor_detail"> </a>
<h2>Constructor Detail</h2>

<a name="gadgets.MiniMessage"> </a>
<h3>gadgets.MiniMessage</h3>

    <pre><b>gadgets.MiniMessage</b>(opt_moduleId, opt_container)</pre>
    <ul>
      Creates a MiniMessage.
    </ul>

    <!-- PARAMETERS START -->
    
    <ul>
        <b>Parameters:</b>
        
        <ul>
            <code><i>String</i>&nbsp;opt_moduleId</code> - Optional module ID 
        </ul>
        
        <ul>
            <code><i>HTMLElement</i>&nbsp;opt_container</code> - Optional HTML container element where
                               mini-messages will appear 
        </ul>
        
    </ul>
    
    <!-- PARAMETERS END -->

<!-- END ADDITIONAL ATTRIBUTES  -->
<!-- ========= CONSTRUCTOR DETAIL END ======== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="gadgets.MiniMessage_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="gadgets.MiniMessage.createDismissibleMessage"> </a> <h3>createDismissibleMessage</h3>
        <pre>HTMLElement <b>createDismissibleMessage</b>(message, opt_callback)</pre> 
    <ul>
       Creates a dismissible message with an [x] icon that allows users to dismiss
the message. When the message is dismissed, it is removed from the DOM
and the optional callback function, if defined, is called.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String, Object</i>&nbsp;message </code> - The message as an HTML string or DOM element 
        </ul>
        <ul>
            <code><i>Function</i>&nbsp;opt_callback </code> - Optional callback function to be called when
                               the message is dismissed 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>HTMLElement</i>&nbsp;</code> HTML element of the created message
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.MiniMessage.createStaticMessage"> </a> <h3>createStaticMessage</h3>
        <pre>HTMLElement <b>createStaticMessage</b>(message)</pre> 
    <ul>
       Creates a static message that can only be dismissed programmatically
(by calling dismissMessage()).
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String, Object</i>&nbsp;message </code> - The message as an HTML string or DOM element 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>HTMLElement</i>&nbsp;</code> HTML element of the created message
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.MiniMessage.createTimerMessage"> </a> <h3>createTimerMessage</h3>
        <pre>HTMLElement <b>createTimerMessage</b>(message, seconds, opt_callback)</pre> 
    <ul>
       Creates a message that displays for the specified number of seconds.
When the timer expires,
the message is dismissed and the optional callback function is executed.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String, Object</i>&nbsp;message </code> - The message as an HTML string or DOM element 
        </ul>
        <ul>
            <code><i>number</i>&nbsp;seconds </code> - Number of seconds to wait before dismissing
                        the message 
        </ul>
        <ul>
            <code><i>Function</i>&nbsp;opt_callback </code> - Optional callback function to be called when
                               the message is dismissed 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>HTMLElement</i>&nbsp;</code> HTML element of the created message
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.MiniMessage.dismissMessage"> </a> <h3>dismissMessage</h3>
        <pre><b>dismissMessage</b>(message)</pre> 
    <ul>
       Dismisses the specified message.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>HTMLElement</i>&nbsp;message </code> - HTML element of the message to remove 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.Prefs">Class gadgets.Prefs</h1>


<!-- <i>Defined in <a href="prefs.src.html">prefs.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.Prefs_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.Prefs_method_detail">DETAIL</a>  
</p>

<p>
Provides access to user preferences, module dimensions, and messages.

Clients can access their preferences by constructing an instance of
gadgets.Prefs and passing in their module ID.  Example:

</p><pre>var prefs = new gadgets.Prefs();
var name = prefs.getString("name");
var lang = prefs.getLang();</pre>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<a name="gadgets.Prefs_constructor_summary"> </a>
<h2>Constructor Summary</h2>
<dl>

    <dt><code>
        <b><a href="#gadgets.Prefs">gadgets.Prefs</a></b>(opt_moduleId)
        </code></dt>
    <dd>Creates a new Prefs object.</dd>

</dl>
&nbsp;
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="gadgets.Prefs_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>
    
<dt><code>
                &nbsp;Array.&lt;String&gt;
                
<b> <a href="#gadgets.Prefs.getArray">getArray</a></b>(key) </code> 
</dt>
<dd>Retrieves a preference as an array.
</dd>

<dt><code>
                &nbsp;Boolean
                
<b> <a href="#gadgets.Prefs.getBool">getBool</a></b>(key) </code> 
</dt>
<dd>Retrieves a preference as a boolean.
</dd>

<dt><code>
                &nbsp;String
                
<b> <a href="#gadgets.Prefs.getCountry">getCountry</a></b>() </code> 
</dt>
<dd>Gets the current country, returned as ISO 3166-1 alpha-2 code.
</dd>

<dt><code>
                &nbsp;Number
                
<b> <a href="#gadgets.Prefs.getFloat">getFloat</a></b>(key) </code> 
</dt>
<dd>Retrieves a preference as a floating-point value.
</dd>

<dt><code>
                &nbsp;Number
                
<b> <a href="#gadgets.Prefs.getInt">getInt</a></b>(key) </code> 
</dt>
<dd>Retrieves a preference as an integer.
</dd>

<dt><code>
                &nbsp;String
                
<b> <a href="#gadgets.Prefs.getLang">getLang</a></b>() </code> 
</dt>
<dd>Gets the current language the gadget should use when rendering, returned as a
ISO 639-1 language code.
</dd>

<dt><code>
                &nbsp;String, Number
                
<b> <a href="#gadgets.Prefs.getModuleId">getModuleId</a></b>() </code> 
</dt>
<dd>Gets the module ID for the current instance.
</dd>

<dt><code>
                &nbsp;String
                
<b> <a href="#gadgets.Prefs.getMsg">getMsg</a></b>(key) </code> 
</dt>
<dd>Fetches an unformatted message.
</dd>

<dt><code>
                &nbsp;String
                
<b> <a href="#gadgets.Prefs.getString">getString</a></b>(key) </code> 
</dt>
<dd>Retrieves a preference as a string.
</dd>

<dt><code>
<b> <a href="#gadgets.Prefs.set">set</a></b>(key, val) </code> 
</dt>
<dd>Stores a preference.
</dd>

<dt><code>
<b> <a href="#gadgets.Prefs.setArray">setArray</a></b>(key, val) </code> 
</dt>
<dd>Stores an array preference.
</dd>

</dl>
&nbsp;


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ========= CONSTRUCTOR DETAIL START ======== -->
<a name="gadgets.Prefs_constructor_detail"> </a>
<h2>Constructor Detail</h2>

<a name="gadgets.Prefs"> </a>
<h3>gadgets.Prefs</h3>

    <pre><b>gadgets.Prefs</b>(opt_moduleId)</pre>
    <ul>
      Creates a new Prefs object.
    </ul>

    <!-- PARAMETERS START -->
    
    <ul>
        <b>Parameters:</b>
        
        <ul>
            <code><i>String, Number</i>&nbsp;opt_moduleId</code> - An optional parameter specifying the
    module ID to create prefs for; if not provided, the default module ID
    is used 
        </ul>
        
    </ul>
    
    <!-- PARAMETERS END -->

<!-- END ADDITIONAL ATTRIBUTES  -->
<!-- ========= CONSTRUCTOR DETAIL END ======== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="gadgets.Prefs_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="gadgets.Prefs.getArray"> </a> <h3>getArray</h3>
        <pre>Array.&lt;String&gt; <b>getArray</b>(key)</pre> 
    <ul>
       Retrieves a preference as an array.
UserPref values that were not declared as lists are treated as
one-element arrays.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The preference to fetch 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Array.&lt;String&gt;</i>&nbsp;</code> The preference; if not set, an empty array
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.Prefs.getBool"> </a> <h3>getBool</h3>
        <pre>Boolean <b>getBool</b>(key)</pre> 
    <ul>
       Retrieves a preference as a boolean.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The preference to fetch 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Boolean</i>&nbsp;</code> The preference; if not set, false
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.Prefs.getCountry"> </a> <h3>getCountry</h3>
        <pre>String <b>getCountry</b>()</pre> 
    <ul>
       Gets the current country, returned as ISO 3166-1 alpha-2 code.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The country for this module instance
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.Prefs.getFloat"> </a> <h3>getFloat</h3>
        <pre>Number <b>getFloat</b>(key)</pre> 
    <ul>
       Retrieves a preference as a floating-point value.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The preference to fetch 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Number</i>&nbsp;</code> The preference; if not set, 0
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.Prefs.getInt"> </a> <h3>getInt</h3>
        <pre>Number <b>getInt</b>(key)</pre> 
    <ul>
       Retrieves a preference as an integer.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The preference to fetch 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Number</i>&nbsp;</code> The preference; if not set, 0
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.Prefs.getLang"> </a> <h3>getLang</h3>
        <pre>String <b>getLang</b>()</pre> 
    <ul>
       Gets the current language the gadget should use when rendering, returned as a
ISO 639-1 language code.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The language for this module instance
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.Prefs.getModuleId"> </a> <h3>getModuleId</h3>
        <pre>String, Number <b>getModuleId</b>()</pre> 
    <ul>
       Gets the module ID for the current instance.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String, Number</i>&nbsp;</code> The module ID for this module instance
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.Prefs.getMsg"> </a> <h3>getMsg</h3>
        <pre>String <b>getMsg</b>(key)</pre> 
    <ul>
       Fetches an unformatted message.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The message to fetch 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The message
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.Prefs.getString"> </a> <h3>getString</h3>
        <pre>String <b>getString</b>(key)</pre> 
    <ul>
       Retrieves a preference as a string.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The preference to fetch 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The preference; if not set, an empty string
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.Prefs.set"> </a> <h3>set</h3>
        <pre><b>set</b>(key, val)</pre> 
    <ul>
       Stores a preference.
To use this call,
the gadget must require the feature setprefs.

<p class="note">
<b>Note:</b>
If the gadget needs to store an Array it should use setArray instead of
this call.
</p>
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The pref to store 
        </ul>
        <ul>
            <code><i>Object</i>&nbsp;val </code> - The values to store 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.Prefs.setArray"> </a> <h3>setArray</h3>
        <pre><b>setArray</b>(key, val)</pre> 
    <ul>
       Stores an array preference.
To use this call,
the gadget must require the feature setprefs.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The pref to store 
        </ul>
        <ul>
            <code><i>Array</i>&nbsp;val </code> - The values to store 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.Tab">Class gadgets.Tab</h1>


<!-- <i>Defined in <a href="tabs.src.html">tabs.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.Tab_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.Tab_method_detail">DETAIL</a>  
</p>

<p>
Tab class for gadgets.
You create tabs using the TabSet addTab() method.
To get Tab objects,
use the TabSet getSelectedTab() or getTabs() methods.

</p><p>
<b>See also:</b>
<a href="#gadgets.TabSet">TabSet</a>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->

<a name="gadgets.Tab_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>
    
<dt><code>
                &nbsp;Function
                
<b> <a href="#gadgets.Tab.getCallback">getCallback</a></b>() </code> 
</dt>
<dd>Returns the callback function that is executed when the tab is selected.
</dd>

<dt><code>
                &nbsp;HTMLElement
                
<b> <a href="#gadgets.Tab.getContentContainer">getContentContainer</a></b>() </code> 
</dt>
<dd>Returns the HTML element where the tab content is rendered.
</dd>

<dt><code>
                &nbsp;Number
                
<b> <a href="#gadgets.Tab.getIndex">getIndex</a></b>() </code> 
</dt>
<dd>Returns the tab's index.
</dd>

<dt><code>
                &nbsp;String
                
<b> <a href="#gadgets.Tab.getName">getName</a></b>() </code> 
</dt>
<dd>Returns the label of the tab as a string (may contain HTML).
</dd>

<dt><code>
                &nbsp;HTMLElement
                
<b> <a href="#gadgets.Tab.getNameContainer">getNameContainer</a></b>() </code> 
</dt>
<dd>Returns the HTML element that contains the tab's label.
</dd>

</dl>
&nbsp;


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<a name="gadgets.Tab_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="gadgets.Tab.getCallback"> </a> <h3>getCallback</h3>
        <pre>Function <b>getCallback</b>()</pre> 
    <ul>
       Returns the callback function that is executed when the tab is selected.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Function</i>&nbsp;</code> The callback function of the tab
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.Tab.getContentContainer"> </a> <h3>getContentContainer</h3>
        <pre>HTMLElement <b>getContentContainer</b>()</pre> 
    <ul>
       Returns the HTML element where the tab content is rendered.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>HTMLElement</i>&nbsp;</code> The HTML element of the content container
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.Tab.getIndex"> </a> <h3>getIndex</h3>
        <pre>Number <b>getIndex</b>()</pre> 
    <ul>
       Returns the tab's index.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Number</i>&nbsp;</code> The tab's index
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.Tab.getName"> </a> <h3>getName</h3>
        <pre>String <b>getName</b>()</pre> 
    <ul>
       Returns the label of the tab as a string (may contain HTML).
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The label of the tab
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.Tab.getNameContainer"> </a> <h3>getNameContainer</h3>
        <pre>HTMLElement <b>getNameContainer</b>()</pre> 
    <ul>
       Returns the HTML element that contains the tab's label.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>HTMLElement</i>&nbsp;</code> The HTML element of the tab's label
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.TabSet">Class gadgets.TabSet</h1>


<!-- <i>Defined in <a href="tabs.src.html">tabs.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.TabSet_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.TabSet_method_detail">DETAIL</a>  
</p>

<p>
A class gadgets can use to make tabs.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<a name="gadgets.TabSet_constructor_summary"> </a>
<h2>Constructor Summary</h2>
<dl>

    <dt><code>
        <b><a href="#gadgets.TabSet">gadgets.TabSet</a></b>(opt_moduleId, opt_defaultTab, opt_container)
        </code></dt>
    <dd>Creates a new TabSet object</dd>

</dl>
&nbsp;
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="gadgets.TabSet_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>
    
<dt><code>
                &nbsp;String
                
<b> <a href="#gadgets.TabSet.addTab">addTab</a></b>(tabName, opt_params) </code> 
</dt>
<dd>Adds a new tab based on the name-value pairs specified in opt_params.
</dd>

<dt><code>
<b> <a href="#gadgets.TabSet.alignTabs">alignTabs</a></b>(align, opt_offset) </code> 
</dt>
<dd>Sets the alignment of tabs.
</dd>

<dt><code>
<b> <a href="#gadgets.TabSet.displayTabs">displayTabs</a></b>(display) </code> 
</dt>
<dd>Shows or hides tabs and all associated content.
</dd>

<dt><code>
                &nbsp;HTMLElement
                
<b> <a href="#gadgets.TabSet.getHeaderContainer">getHeaderContainer</a></b>() </code> 
</dt>
<dd>Returns the tab headers container element.
</dd>

<dt><code>
                &nbsp;gadgets.Tab
                
<b> <a href="#gadgets.TabSet.getSelectedTab">getSelectedTab</a></b>() </code> 
</dt>
<dd>Returns the currently selected tab object.
</dd>

<dt><code>
                &nbsp;Array.&lt;gadgets.Tab&gt;
                
<b> <a href="#gadgets.TabSet.getTabs">getTabs</a></b>() </code> 
</dt>
<dd>Returns an array of all existing tab objects.
</dd>

<dt><code>
<b> <a href="#gadgets.TabSet.removeTab">removeTab</a></b>(tabIndex) </code> 
</dt>
<dd>Removes a tab at tabIndex and all of its associated content.
</dd>

<dt><code>
<b> <a href="#gadgets.TabSet.setSelectedTab">setSelectedTab</a></b>(tabIndex) </code> 
</dt>
<dd>Selects the tab at tabIndex and fires the tab's callback function if it
exists.
</dd>

<dt><code>
<b> <a href="#gadgets.TabSet.swapTabs">swapTabs</a></b>(tabIndex1, tabIndex2) </code> 
</dt>
<dd>Swaps the positions of tabs at tabIndex1 and tabIndex2.
</dd>

</dl>
&nbsp;


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ========= CONSTRUCTOR DETAIL START ======== -->
<a name="gadgets.TabSet_constructor_detail"> </a>
<h2>Constructor Detail</h2>

<a name="gadgets.TabSet"> </a>
<h3>gadgets.TabSet</h3>

    <pre><b>gadgets.TabSet</b>(opt_moduleId, opt_defaultTab, opt_container)</pre>
    <ul>
      Creates a new TabSet object
    </ul>

    <!-- PARAMETERS START -->
    
    <ul>
        <b>Parameters:</b>
        
        <ul>
            <code><i>String</i>&nbsp;opt_moduleId</code> - Optional suffix for the ID of tab container 
        </ul>
        
        <ul>
            <code><i>String</i>&nbsp;opt_defaultTab</code> - Optional tab name that specifies the name of
                  of the tab that is selected after initialization;
                  if this parameter is omitted, the first tab is selected by
                  default 
        </ul>
        
        <ul>
            <code><i>HTMLElement</i>&nbsp;opt_container</code> - The HTML element to contain the tabs; if
                   omitted, a new div element is created and inserted at the
                   very top 
        </ul>
        
    </ul>
    
    <!-- PARAMETERS END -->

<!-- END ADDITIONAL ATTRIBUTES  -->
<!-- ========= CONSTRUCTOR DETAIL END ======== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="gadgets.TabSet_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="gadgets.TabSet.addTab"> </a> <h3>addTab</h3>
        <pre>String <b>addTab</b>(tabName, opt_params)</pre> 
    <ul>
       Adds a new tab based on the name-value pairs specified in opt_params.
The following properties are supported in opt_params:
<dl>
<dt>contentContainer</dt>
  <dd>An existing HTML element to be used as
      the tab content container. If omitted, the tabs
      library creates one. </dd>
<dt>callback</dt>
  <dd>A callback function to be executed when the tab
      is selected. </dd>
<dt>tooltip</dt>
  <dd>A tooltip description that pops up when user moves
      the mouse cursor over the tab.</dd>
<dt>index</dt>
  <dd>The index at which to insert the tab. If omitted,
      the new tab is appended to the end.</dd>
</dl>
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;tabName </code> - Label of the tab to create 
        </ul>
        <ul>
            <code><i>Object</i>&nbsp;opt_params </code> - Optional parameter object 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> DOM id of the tab container
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.TabSet.alignTabs"> </a> <h3>alignTabs</h3>
        <pre><b>alignTabs</b>(align, opt_offset)</pre> 
    <ul>
       Sets the alignment of tabs. Tabs are center-aligned by default.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;align </code> - 'left', 'center', or 'right' 
        </ul>
        <ul>
            <code><i>Number</i>&nbsp;opt_offset </code> - Optional parameter to set the number of pixels
                  to offset tabs from the left or right edge; the default
                  value is 3px 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.TabSet.displayTabs"> </a> <h3>displayTabs</h3>
        <pre><b>displayTabs</b>(display)</pre> 
    <ul>
       Shows or hides tabs and all associated content.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Boolean</i>&nbsp;display </code> - True to show tabs; false to hide tabs 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.TabSet.getHeaderContainer"> </a> <h3>getHeaderContainer</h3>
        <pre>HTMLElement <b>getHeaderContainer</b>()</pre> 
    <ul>
       Returns the tab headers container element.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>HTMLElement</i>&nbsp;</code> The tab headers container element
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.TabSet.getSelectedTab"> </a> <h3>getSelectedTab</h3>
        <pre>gadgets.Tab <b>getSelectedTab</b>()</pre> 
    <ul>
       Returns the currently selected tab object.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>gadgets.Tab</i>&nbsp;</code> The currently selected tab object
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.TabSet.getTabs"> </a> <h3>getTabs</h3>
        <pre>Array.&lt;gadgets.Tab&gt; <b>getTabs</b>()</pre> 
    <ul>
       Returns an array of all existing tab objects.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Array.&lt;gadgets.Tab&gt;</i>&nbsp;</code> Array of all existing tab objects
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.TabSet.removeTab"> </a> <h3>removeTab</h3>
        <pre><b>removeTab</b>(tabIndex)</pre> 
    <ul>
       Removes a tab at tabIndex and all of its associated content.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Number</i>&nbsp;tabIndex </code> - Index of the tab to remove 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.TabSet.setSelectedTab"> </a> <h3>setSelectedTab</h3>
        <pre><b>setSelectedTab</b>(tabIndex)</pre> 
    <ul>
       Selects the tab at tabIndex and fires the tab's callback function if it
exists. If the tab is already selected, the callback is not fired.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Number</i>&nbsp;tabIndex </code> - Index of the tab to select 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.TabSet.swapTabs"> </a> <h3>swapTabs</h3>
        <pre><b>swapTabs</b>(tabIndex1, tabIndex2)</pre> 
    <ul>
       Swaps the positions of tabs at tabIndex1 and tabIndex2. The selected tab
does not change, and no callback functions are called.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Number</i>&nbsp;tabIndex1 </code> - Index of the first tab to swap 
        </ul>
        <ul>
            <code><i>Number</i>&nbsp;tabIndex2 </code> - Index of the secnod tab to swap 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.flash">Static Class gadgets.flash</h1>


<!-- <i>Defined in <a href="flash.src.html">flash.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.flash_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.flash_method_detail">DETAIL</a>  
</p>

<p>
Embeds Flash content in gadgets.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->

<a name="gadgets.flash_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>
    
<dt><code>&lt;static&gt; 
                &nbsp;Boolean
                
<b> <a href="#gadgets.flash.embedCachedFlash">embedCachedFlash</a></b>() </code> 
</dt>
<dd>Injects a cached Flash file into the DOM tree.
</dd>

<dt><code>&lt;static&gt; 
                &nbsp;Boolean
                
<b> <a href="#gadgets.flash.embedFlash">embedFlash</a></b>(swfUrl, swfContainer, swfVersion, opt_params) </code> 
</dt>
<dd>Injects a Flash file into the DOM tree.
</dd>

<dt><code>&lt;static&gt; 
                &nbsp;Number
                
<b> <a href="#gadgets.flash.getMajorVersion">getMajorVersion</a></b>() </code> 
</dt>
<dd>Detects Flash Player and its major version.
</dd>

</dl>
&nbsp;


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<a name="gadgets.flash_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="gadgets.flash.embedCachedFlash"> </a> <h3>embedCachedFlash</h3>
        <pre>&lt;static&gt; Boolean <b>embedCachedFlash</b>()</pre> 
    <ul>
       Injects a cached Flash file into the DOM tree.
Accepts the same parameters as gadgets.flash.embedFlash does.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Boolean</i>&nbsp;</code> Whether the function call completes successfully
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.flash.embedFlash"> </a> <h3>embedFlash</h3>
        <pre>&lt;static&gt; Boolean <b>embedFlash</b>(swfUrl, swfContainer, swfVersion, opt_params)</pre> 
    <ul>
       Injects a Flash file into the DOM tree.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;swfUrl </code> - SWF URL 
        </ul>
        <ul>
            <code><i>String, Object</i>&nbsp;swfContainer </code> - The ID or object reference of an
    existing HTML container element 
        </ul>
        <ul>
            <code><i>Number</i>&nbsp;swfVersion </code> - Minimum Flash Player version required 
        </ul>
        <ul>
            <code><i>Object</i>&nbsp;opt_params </code> - An optional object that may contain any valid HTML
    parameter; all attributes will be passed through to the Flash movie on
    creation 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Boolean</i>&nbsp;</code> Whether the function call completes successfully
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.flash.getMajorVersion"> </a> <h3>getMajorVersion</h3>
        <pre>&lt;static&gt; Number <b>getMajorVersion</b>()</pre> 
    <ul>
       Detects Flash Player and its major version.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Number</i>&nbsp;</code> The major version of Flash Player
                 or 0 if Flash is not supported
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.io">Static Class gadgets.io</h1>


<!-- <i>Defined in <a href="io.src.html">io.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.io_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.io_method_detail">DETAIL</a>  
</p>

<p>
Provides remote content retrieval functions.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->

<a name="gadgets.io_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>
    
<dt><code>&lt;static&gt; 
                &nbsp;String
                
<b> <a href="#gadgets.io.encodeValues">encodeValues</a></b>(fields) </code> 
</dt>
<dd>Converts an input object into a URL-encoded data string.
</dd>

<dt><code>&lt;static&gt; 
                &nbsp;String
                
<b> <a href="#gadgets.io.getProxyUrl">getProxyUrl</a></b>(url, opt_params) </code> 
</dt>
<dd>Gets the proxy version of the passed-in URL.
</dd>

<dt><code>&lt;static&gt; 
<b> <a href="#gadgets.io.makeRequest">makeRequest</a></b>(url, callback, opt_params) </code> 
</dt>
<dd>Fetches content from the provided URL and feeds that content into the
callback function.
</dd>

</dl>
&nbsp;


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<a name="gadgets.io_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="gadgets.io.encodeValues"> </a> <h3>encodeValues</h3>
        <pre>&lt;static&gt; String <b>encodeValues</b>(fields)</pre> 
    <ul>
       Converts an input object into a URL-encoded data string.
(key=value&amp;...)
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Object</i>&nbsp;fields </code> - The post fields you wish to encode 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The processed post data; this includes a trailing
   ampersand (&amp;)
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.io.getProxyUrl"> </a> <h3>getProxyUrl</h3>
        <pre>&lt;static&gt; String <b>getProxyUrl</b>(url, opt_params)</pre> 
    <ul>
       Gets the proxy version of the passed-in URL.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;url </code> - The URL to get the proxy URL for 
        </ul>
        <ul>
            <code><i>Map&lt;String, String&gt;</i>&nbsp;opt_params </code> - Additional optional
    <a href="#gadgets.io.ProxyUrlRequestParameters">parameters</a>
    to pass to the request 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The proxied version of the URL
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.io.makeRequest"> </a> <h3>makeRequest</h3>
        <pre>&lt;static&gt; <b>makeRequest</b>(url, callback, opt_params)</pre> 
    <ul>
       Fetches content from the provided URL and feeds that content into the
callback function.
Example:
<pre>var params = {};
params[gadgets.io.RequestParameters.CONTENT_TYPE] = gadgets.io.ContentType.TEXT;
gadgets.io.makeRequest(url, callback, params);
</pre>

<h4>Signed authorization</h4>

<p>
If <code><em>opt_params</em>[gadgets.io.RequestParameters.AUTHORIZATION]</code> is set to
<code>gadgets.io.AuthorizationType.SIGNED</code>,
the container needs to vouch
for the user's identity to
the destination server.
The container does this by doing the following:
</p>

<ol>
<li><p>
  Removing any request parameters with names that begin with <code>oauth</code>, <code>xoauth</code>,
     or <code>opensocial</code> (case insensitive). </p> </li>
<li><p>
  Adding the following parameters to the request query string:</p>
  <dl>
  <dt>
     opensocial_viewer_id</dt>
  <dd><em>Optional.</em><br>
       The ID of the current viewer, which
       matches the <code>getId()</code> value on the viewer person object.</dd>
         <dt>
     opensocial_owner_id</dt>
  <dd><b>Required.</b><br>
      The ID of the current owner, which
       matches the <code>getId()</code> value on the owner person object.</dd>
  <dt>
     opensocial_app_url</dt>
  <dd><b>Required.</b><br>
      The URL of the application making the
       request. Containers may alias multiple application URLs to a single
       canonical application URL in the case where an application changes
       URLs. </dd>
   <dt> 
     opensocial_instance_id</dt>
  <dd><em>Optional.</em><br>
       An opaque identifier
       used to distinguish between multiple instances of the same application
       in a single container.  If a container does not allow multiple
       instances of the same application to coexist, this parameter may be
       omitted.  The combination of <code>opensocial_app_url</code> and
       <code>opensocial_instance_id</code>
       uniquely identify an instance of an
       application in a container. </dd>
     <dt>
     opensocial_app_id</dt>
  <dd><em>Optional.</em><br>
         An opaque identifier for the
       application, unique to a particular container.  
       Containers that wish to maintain backwards compatibility
       with the opensocial-0.7 specification may include this parameter.
     </dd><dt>
     xoauth_public_key</dt>
  <dd><em>Optional.</em><br>
         An opaque identifier for the
       public key used to sign the request.  This parameter may be omitted by
       containers that do not use public keys to sign requests, or if the
       container arranges other means of key distribution with the target of
       the request. </dd>
   </dl>
  </li><li><p>
     Signing the resulting request according to section 9 of the
     <a href="http://oauth.net/core/1.0/#signing_process">OAuth
      specification</a>.</p>
   </li>
   </ol></ul>

<h4>
Key management for gadgets.io.AuthorizationType.SIGNED
</h4>

<p>
If a container uses public keys to sign requests,
the container may choose to
use either self-signed certificates
or certificates signed by a well-known
certificate authority.
If a container does not distribute its OAuth signing
key over HTTPS, it should use a certificate signed by a well-known
certificate authority.
</p>

<p>
The <code>commonName</code> attribute of the certificate should match the
hostname of the container server, and should also match the value of
the <code>oauth_consumer_key</code> parameter specified in the request.
</p>

<p>
The container should make its public key available for download
at a well-known location. The location
<code>https://<em>container-hostname</em>/opensocial/certificates/<em>xoauth_public_keyvalue</em></code>
is recommended.
</p>

<p>
Recipients of signed requests must verify that the signature on
the request is correct, and that the timestamp on the request is
within a reasonable time window.  A time window of
5 minutes before and after
the current time is recommended.
</p>

<p>
Recipients of signed requests may use the <code>oauth_consumer_key</code> and
<code>xoauth_public_key</code> parameters to automatically detect when a container
deploys new certificates.  If the container deploys certificates at a
well-known location, the recipient may automatically download the new
certificate.  Recipients that automatically download new certificates
should cache the resulting certificates.
</p>

<p>
If a container's certificate is not downloaded from
<code>https://<em>container-hostname</em></code>, the recipient should verify that the
certificate is signed by a well-known certificate authority before
trusting the certificate.
</p>

<h4>OAuth authorization</h4>

<p>
If <code><em>opt_params</em>[gadgets.io.RequestParameters.AUTHORIZATION]</code> is set
to <code>gadgets.io.AuthorizationType.OAUTH</code>,
the container needs to use OAuth to gain access to
the resource specified in the request.
This may require that the gadget obtain the user's content by
directing the user to the service provider to gain access.
</p>

<h4>Additional parameters</h4>
<p>
The following additional parameters may be specified in <code>opt_params</code>:
</p>

<dl>
<dt>
gadgets.io.RequestParameters.OAUTH_SERVICE_NAME
</dt>
<dd>
  The nickname the gadget uses to refer to the OAuth &lt;Service&gt;
element from its XML spec.  If unspecified, defaults to "".
</dd>

<dt>
gadgets.io.RequestParameters.OAUTH_TOKEN_NAME
</dt>
<dd>
  The nickname the gadget uses to refer to an OAuth token granting
access to a particular resources.  If unspecified, defaults to "".
  Gadgets can use multiple token names if they have access to
multiple resources from the same service provider.  For example, a
gadget with access to a contact list and a calendar might use a token
name of "contacts" to use the contact list token, and a contact list
of "calendar" to use the calendar token.
</dd>

<dt>
gadgets.io.RequestParameters.OAUTH_REQUEST_TOKEN
</dt>
<dd>
   A service provider may be able to automatically provision a
gadget with a request token that is preapproved for access to a
resource. The gadget can use that token with the OAUTH_REQUEST_TOKEN
parameter. This parameter is optional.
</dd>

<dt>
gadgets.io.RequestParameters.OAUTH_REQUEST_TOKEN_SECRET
</dt>
<dd>
  The secret corresponding to a preapproved request token.  This
parameter is optional.
</dd>
</dl>

<p>
If OAuth is used, the container should execute the OAuth protocol on
behalf of the gadget.  If the gadget has not registered a consumer key
for use with this service provider, the container may choose to use a
default RSA signing key corresponding to a well-known certificate to sign
requests.  If the container uses a default consumer key, it will include
an additional OAuth parameter <code>xoauth_app_url</code> that identifies the gadget
making the request.
</p>

<h4>The callback parameter</h4>

<p>
The <code>makeRequest()</code> callback parameter
is passed a javascript object with
several OAuth-specific fields in addition to the normal values returned
by <code>makeRequest()</code>:
</p>

<dl>
<dt>
"oauthApprovalUrl"</dt>
<dd>
If this value is specified, the user needs to
visit an external page to approve the gadget's request to access
data.  Use of a pop-up window to direct the user to the external
page is recommended.  Once the user has approved access, the gadget
can repeat the makeRequest call to retrieve the data.
</dd>

<dt>
"oauthError"</dt>
<dd>
If this value is specified, it indicates an OAuth-related
error occurred.  The value will be one of a set of string
constants that can be used for programmatically detecting errors.
The constants are undefined for opensocial-0.8, but implementers
should attempt to agree on a set of useful constant values for
standardization in opensocial-0.9.
</dd>

<dt>
"oauthErrorText"</dt>
<dd>If this value is specified, it indicates an
OAuth-related error occurred.  The value is free-form text that
can be used to provide debugging information for gadget developers.
</dd>
</dl>
    
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;url </code> - The URL where the content is located 
        </ul>
        <ul>
            <code><i>Function</i>&nbsp;callback </code> - The function to call with the data from the
    URL once it is fetched 
        </ul>
        <ul>
            <code><i>Map.&lt;gadgets.io.RequestParameters, Object&gt;</i>&nbsp;opt_params </code> - Additional
    <a href="#gadgets.io.RequestParameters">request parameters</a> or
    <a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/gadgets.io.ProxyUrlRequestParameters">proxy 
      	request parameters</a> 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.io.AuthorizationType">Static Class gadgets.io.AuthorizationType</h1>


<!-- <i>Defined in <a href="io.src.html">io.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.io.AuthorizationType_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.io.AuthorizationType_field_detail">DETAIL</a>  
</p>

<p>
Used by
<a href="#gadgets.io.RequestParameters">
RequestParameters</a>.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="gadgets.io.AuthorizationType_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.AuthorizationType.NONE">NONE</a></b></code>
</dt>
<dd>No authorization.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.AuthorizationType.OAUTH">OAUTH</a></b></code>
</dt>
<dd>The container will use OAuth for authentication.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.AuthorizationType.SIGNED">SIGNED</a></b></code>
</dt>
<dd>The request will be signed by the container.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="gadgets.io.AuthorizationType_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="gadgets.io.AuthorizationType.NONE">
    <!-- -->
    </a> <h3>NONE</h3>
        <pre>&lt;static&gt; object <b>NONE</b></pre> 
    <ul>
       No authorization.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.io.AuthorizationType.OAUTH">
    <!-- -->
    </a> <h3>OAUTH</h3>
        <pre>&lt;static&gt; object <b>OAUTH</b></pre> 
    <ul>
       The container will use OAuth for authentication.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.io.AuthorizationType.SIGNED">
    <!-- -->
    </a> <h3>SIGNED</h3>
        <pre>&lt;static&gt; object <b>SIGNED</b></pre> 
    <ul>
       The request will be signed by the container.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.io.ContentType">Static Class gadgets.io.ContentType</h1>


<!-- <i>Defined in <a href="io.src.html">io.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.io.ContentType_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.io.ContentType_field_detail">DETAIL</a>  
</p>

<p>
Used by
<a href="#gadgets.io.RequestParameters">
RequestParameters</a>.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="gadgets.io.ContentType_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.ContentType.DOM">DOM</a></b></code>
</dt>
<dd>Returns a DOM object; used for fetching XML.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.ContentType.FEED">FEED</a></b></code>
</dt>
<dd>Returns a JSON representation of an RSS or Atom feed.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.ContentType.JSON">JSON</a></b></code>
</dt>
<dd>Returns a JSON object.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.ContentType.TEXT">TEXT</a></b></code>
</dt>
<dd>Returns text; used for fetching HTML.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="gadgets.io.ContentType_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="gadgets.io.ContentType.DOM">
    <!-- -->
    </a> <h3>DOM</h3>
        <pre>&lt;static&gt; object <b>DOM</b></pre> 
    <ul>
       Returns a DOM object; used for fetching XML.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.io.ContentType.FEED">
    <!-- -->
    </a> <h3>FEED</h3>
        <pre>&lt;static&gt; object <b>FEED</b></pre> 
    <ul>
       Returns a JSON representation of an RSS or Atom feed.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.io.ContentType.JSON">
    <!-- -->
    </a> <h3>JSON</h3>
        <pre>&lt;static&gt; object <b>JSON</b></pre> 
    <ul>
       Returns a JSON object.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.io.ContentType.TEXT">
    <!-- -->
    </a> <h3>TEXT</h3>
        <pre>&lt;static&gt; object <b>TEXT</b></pre> 
    <ul>
       Returns text; used for fetching HTML.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.io.MethodType">Static Class gadgets.io.MethodType</h1>


<!-- <i>Defined in <a href="io.src.html">io.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.io.MethodType_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.io.MethodType_field_detail">DETAIL</a>  
</p>

<p>
Defines values for
<a href="#gadgets.io.RequestParameters.METHOD">
RequestParameters.METHOD</a>.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="gadgets.io.MethodType_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.MethodType.DELETE">DELETE</a></b></code>
</dt>
<dd>Container support for this method type is OPTIONAL.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.MethodType.GET">GET</a></b></code>
</dt>
<dd>The default type.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.MethodType.HEAD">HEAD</a></b></code>
</dt>
<dd>Container support for this method type is OPTIONAL.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.MethodType.POST">POST</a></b></code>
</dt>
<dd>Container support for this method type is OPTIONAL.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.MethodType.PUT">PUT</a></b></code>
</dt>
<dd>Container support for this method type is OPTIONAL.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="gadgets.io.MethodType_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="gadgets.io.MethodType.DELETE">
    <!-- -->
    </a> <h3>DELETE</h3>
        <pre>&lt;static&gt; object <b>DELETE</b></pre> 
    <ul>
       Container support for this method type is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.io.MethodType.GET">
    <!-- -->
    </a> <h3>GET</h3>
        <pre>&lt;static&gt; object <b>GET</b></pre> 
    <ul>
       The default type.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.io.MethodType.HEAD">
    <!-- -->
    </a> <h3>HEAD</h3>
        <pre>&lt;static&gt; object <b>HEAD</b></pre> 
    <ul>
       Container support for this method type is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.io.MethodType.POST">
    <!-- -->
    </a> <h3>POST</h3>
        <pre>&lt;static&gt; object <b>POST</b></pre> 
    <ul>
       Container support for this method type is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.io.MethodType.PUT">
    <!-- -->
    </a> <h3>PUT</h3>
        <pre>&lt;static&gt; object <b>PUT</b></pre> 
    <ul>
       Container support for this method type is OPTIONAL.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.io.ProxyUrlRequestParameters">Static Class gadgets.io.ProxyUrlRequestParameters</h1>


<!-- <i>Defined in <a href="io.src.html">io.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.io.ProxyUrlRequestParameters_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.io.ProxyUrlRequestParameters_field_detail">DETAIL</a>  
</p>

<p>
Used by
<a href="#gadgets.io.getProxyUrl">
<code>gadgets.io.getProxyUrl()</code></a> method.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="gadgets.io.ProxyUrlRequestParameters_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.ProxyUrlRequestParameters.REFRESH_INTERVAL">REFRESH_INTERVAL</a></b></code>
</dt>
<dd>Attempt to use content caching.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="gadgets.io.ProxyUrlRequestParameters_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="gadgets.io.ProxyUrlRequestParameters.REFRESH_INTERVAL">
    <!-- -->
    </a> <h3>REFRESH_INTERVAL</h3>
        <pre>&lt;static&gt; object <b>REFRESH_INTERVAL</b></pre> 
    <ul>
       Attempt to use content caching. The Refresh Interval is the number
of seconds we want to cache the given response. By default the HTTP headers
will be respected. If there aren't any HTTP headers this value will default
to 3600 (one hour). Note that Signed requests and objects with POST_DATA
present will generally not be cached.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.io.RequestParameters">Static Class gadgets.io.RequestParameters</h1>


<!-- <i>Defined in <a href="io.src.html">io.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.io.RequestParameters_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.io.RequestParameters_field_detail">DETAIL</a>  
</p>

<p>
Used by the
<a href="#gadgets.io.makeRequest">
<code>gadgets.io.makeRequest()</code></a> method.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="gadgets.io.RequestParameters_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.RequestParameters.AUTHORIZATION">AUTHORIZATION</a></b></code>
</dt>
<dd>The type of authentication to use when fetching the content;
defaults to <code>AuthorizationType.NONE</code>.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.RequestParameters.CONTENT_TYPE">CONTENT_TYPE</a></b></code>
</dt>
<dd>The type of content that lives at the URL;
defaults to <code>ContentType.TEXT</code>.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.RequestParameters.GET_SUMMARIES">GET_SUMMARIES</a></b></code>
</dt>
<dd>If the content is a feed, whether to fetch summaries for that feed;
defaults to false.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.RequestParameters.HEADERS">HEADERS</a></b></code>
</dt>
<dd>The HTTP headers to send to the URL;
defaults to null.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.RequestParameters.METHOD">METHOD</a></b></code>
</dt>
<dd>The method to use when fetching content from the URL;
defaults to <code>MethodType.GET</code>.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.RequestParameters.NUM_ENTRIES">NUM_ENTRIES</a></b></code>
</dt>
<dd>If the content is a feed, the number of entries to fetch;
defaults to 3.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.io.RequestParameters.POST_DATA">POST_DATA</a></b></code>
</dt>
<dd>The data to send to the URL using the POST method;
defaults to null.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="gadgets.io.RequestParameters_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="gadgets.io.RequestParameters.AUTHORIZATION">
    <!-- -->
    </a> <h3>AUTHORIZATION</h3>
        <pre>&lt;static&gt; object <b>AUTHORIZATION</b></pre> 
    <ul>
       The type of authentication to use when fetching the content;
defaults to <code>AuthorizationType.NONE</code>.
Specified as an
<a href="#gadgets.io.AuthorizationType">
AuthorizationType</a>.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.io.RequestParameters.CONTENT_TYPE">
    <!-- -->
    </a> <h3>CONTENT_TYPE</h3>
        <pre>&lt;static&gt; object <b>CONTENT_TYPE</b></pre> 
    <ul>
       The type of content that lives at the URL;
defaults to <code>ContentType.TEXT</code>.
Specified as a
<a href="#gadgets.io.ContentType">
ContentType</a>.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.io.RequestParameters.GET_SUMMARIES">
    <!-- -->
    </a> <h3>GET_SUMMARIES</h3>
        <pre>&lt;static&gt; object <b>GET_SUMMARIES</b></pre> 
    <ul>
       If the content is a feed, whether to fetch summaries for that feed;
defaults to false.
Specified as a <code>Boolean</code>.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.io.RequestParameters.HEADERS">
    <!-- -->
    </a> <h3>HEADERS</h3>
        <pre>&lt;static&gt; object <b>HEADERS</b></pre> 
    <ul>
       The HTTP headers to send to the URL;
defaults to null.
Specified as a <code>Map.&lt;String,String&gt;</code>.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.io.RequestParameters.METHOD">
    <!-- -->
    </a> <h3>METHOD</h3>
        <pre>&lt;static&gt; object <b>METHOD</b></pre> 
    <ul>
       The method to use when fetching content from the URL;
defaults to <code>MethodType.GET</code>.
Valid values are specified by
<a href="#gadgets.io.MethodType">MethodType</a>.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.io.RequestParameters.NUM_ENTRIES">
    <!-- -->
    </a> <h3>NUM_ENTRIES</h3>
        <pre>&lt;static&gt; object <b>NUM_ENTRIES</b></pre> 
    <ul>
       If the content is a feed, the number of entries to fetch;
defaults to 3.
Specified as a <code>Number</code>.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.io.RequestParameters.POST_DATA">
    <!-- -->
    </a> <h3>POST_DATA</h3>
        <pre>&lt;static&gt; object <b>POST_DATA</b></pre> 
    <ul>
       The data to send to the URL using the POST method;
defaults to null.
Specified as a <code>String</code>.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.json">Static Class gadgets.json</h1>


<!-- <i>Defined in <a href="json.src.html">json.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.json_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.json_method_detail">DETAIL</a>  
</p>

<p>
Provides operations for translating objects to and from JSON.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->

<a name="gadgets.json_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>
    
<dt><code>&lt;static&gt; 
                &nbsp;Object
                
<b> <a href="#gadgets.json.parse">parse</a></b>(text) </code> 
</dt>
<dd>Parses a JSON string, producing a JavaScript value.
</dd>

<dt><code>&lt;static&gt; 
                &nbsp;String
                
<b> <a href="#gadgets.json.stringify">stringify</a></b>(v) </code> 
</dt>
<dd>Converts a JavaScript value to a JSON string.
</dd>

</dl>
&nbsp;


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<a name="gadgets.json_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="gadgets.json.parse"> </a> <h3>parse</h3>
        <pre>&lt;static&gt; Object <b>parse</b>(text)</pre> 
    <ul>
       Parses a JSON string, producing a JavaScript value.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;text </code> - The string to transform into an object —
    usually the result of a previous stringify call 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Object</i>&nbsp;</code> The object parsed from the passed in text; false if
    an error occurred
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.json.stringify"> </a> <h3>stringify</h3>
        <pre>&lt;static&gt; String <b>stringify</b>(v)</pre> 
    <ul>
       Converts a JavaScript value to a JSON string.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Object</i>&nbsp;v </code> - The object to convert 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The JSON equivalent
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.pubsub">Static Class gadgets.pubsub</h1>


<!-- <i>Defined in <a href="pubsub.src.html">pubsub.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.pubsub_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.pubsub_method_detail">DETAIL</a>  
</p>

<p>
Provides operations for publishing and subscribing to message
    channels.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->

<a name="gadgets.pubsub_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>
    
<dt><code>&lt;static&gt; 
<b> <a href="#gadgets.pubsub.publish">publish</a></b>(channelName, message) </code> 
</dt>
<dd>Publishes a string-type message to a channel.
</dd>

<dt><code>&lt;static&gt; 
<b> <a href="#gadgets.pubsub.subscribe">subscribe</a></b>(channelName, callback) </code> 
</dt>
<dd>Subscribes a gadget to a message channel.
</dd>

<dt><code>&lt;static&gt; 
<b> <a href="#gadgets.pubsub.unsubscribe">unsubscribe</a></b>(channelName) </code> 
</dt>
<dd>Unsubscribes the gadget from a message channel.
</dd>

</dl>
&nbsp;


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<a name="gadgets.pubsub_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="gadgets.pubsub.publish"> </a> <h3>publish</h3>
        <pre>&lt;static&gt; <b>publish</b>(channelName, message)</pre> 
    <ul>
       Publishes a string-type message to a channel.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;channelName </code> - The name of the channel 
        </ul>
        <ul>
            <code><i>String</i>&nbsp;message </code> - The message to publish 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.pubsub.subscribe"> </a> <h3>subscribe</h3>
        <pre>&lt;static&gt; <b>subscribe</b>(channelName, callback)</pre> 
    <ul>
       Subscribes a gadget to a message channel.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;channelName </code> - The name of the channel 
        </ul>
        <ul>
            <code><i>Function</i>&nbsp;callback </code> - A function that will be called with the channel
    messages 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.pubsub.unsubscribe"> </a> <h3>unsubscribe</h3>
        <pre>&lt;static&gt; <b>unsubscribe</b>(channelName)</pre> 
    <ul>
       Unsubscribes the gadget from a message channel.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;channelName </code> - The name of the channel 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.rpc">Static Class gadgets.rpc</h1>


<!-- <i>Defined in <a href="rpc.src.html">rpc.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.rpc_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.rpc_method_detail">DETAIL</a>  
</p>

<p>
Provides operations for making remote procedure calls
for gadget-to-container,
container-to-gadget, and gadget-to-gadget communication.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->

<a name="gadgets.rpc_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>
    
<dt><code>&lt;static&gt; 
<b> <a href="#gadgets.rpc.call">call</a></b>(targetId, serviceName, callback, var_args) </code> 
</dt>
<dd>Calls an RPC service.
</dd>

<dt><code>&lt;static&gt; 
<b> <a href="#gadgets.rpc.register">register</a></b>(serviceName, handler) </code> 
</dt>
<dd>Registers an RPC service.
</dd>

<dt><code>&lt;static&gt; 
<b> <a href="#gadgets.rpc.registerDefault">registerDefault</a></b>(handler) </code> 
</dt>
<dd>Registers a default service handler to process all unknown
remote procedure calls, which fail silently by default.
</dd>

<dt><code>&lt;static&gt; 
<b> <a href="#gadgets.rpc.unregister">unregister</a></b>(serviceName) </code> 
</dt>
<dd>Unregisters an RPC service.
</dd>

<dt><code>&lt;static&gt; 
<b> <a href="#gadgets.rpc.unregisterDefault">unregisterDefault</a></b>() </code> 
</dt>
<dd>Unregisters the default service handler.
</dd>

</dl>
&nbsp;


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<a name="gadgets.rpc_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="gadgets.rpc.call"> </a> <h3>call</h3>
        <pre>&lt;static&gt; <b>call</b>(targetId, serviceName, callback, var_args)</pre> 
    <ul>
       Calls an RPC service.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;targetId </code> - ID of the RPC service provider;
                         empty if calling the parent container 
        </ul>
        <ul>
            <code><i>String</i>&nbsp;serviceName </code> - Service name to call 
        </ul>
        <ul>
            <code><i>Function, null</i>&nbsp;callback </code> - Callback function (if any) to process
                                the return value of the RPC request 
        </ul>
        <ul>
            <code><i>*</i>&nbsp;var_args </code> - Parameters for the RPC request 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.rpc.register"> </a> <h3>register</h3>
        <pre>&lt;static&gt; <b>register</b>(serviceName, handler)</pre> 
    <ul>
       Registers an RPC service.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;serviceName </code> - Service name to register 
        </ul>
        <ul>
            <code><i>Function</i>&nbsp;handler </code> - Service handler 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.rpc.registerDefault"> </a> <h3>registerDefault</h3>
        <pre>&lt;static&gt; <b>registerDefault</b>(handler)</pre> 
    <ul>
       Registers a default service handler to process all unknown
remote procedure calls, which fail silently by default.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Function</i>&nbsp;handler </code> - Service handler 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.rpc.unregister"> </a> <h3>unregister</h3>
        <pre>&lt;static&gt; <b>unregister</b>(serviceName)</pre> 
    <ul>
       Unregisters an RPC service.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;serviceName </code> - Service name to unregister 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.rpc.unregisterDefault"> </a> <h3>unregisterDefault</h3>
        <pre>&lt;static&gt; <b>unregisterDefault</b>()</pre> 
    <ul>
       Unregisters the default service handler. Future unknown remote procedure
calls will fail silently.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.skins">Static Class gadgets.skins</h1>


<!-- <i>Defined in <a href="skins.src.html">skins.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.skins_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.skins_method_detail">DETAIL</a>  
</p>

<p>
Provides operations for getting display information about the
    currently shown skin.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->

<a name="gadgets.skins_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>
    
<dt><code>&lt;static&gt; 
                &nbsp;String
                
<b> <a href="#gadgets.skins.getProperty">getProperty</a></b>(propertyKey) </code> 
</dt>
<dd>Fetches the display property mapped to the given key.
</dd>

</dl>
&nbsp;


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<a name="gadgets.skins_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="gadgets.skins.getProperty"> </a> <h3>getProperty</h3>
        <pre>&lt;static&gt; String <b>getProperty</b>(propertyKey)</pre> 
    <ul>
       Fetches the display property mapped to the given key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;propertyKey </code> - The key to get data for;
   keys are defined in <a href="#gadgets.skins.Property"><code>
   gadgets.skins.Property</code></a> 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The data
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.skins.Property">Static Class gadgets.skins.Property</h1>


<!-- <i>Defined in <a href="skins.src.html">skins.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.skins.Property_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.skins.Property_field_detail">DETAIL</a>  
</p>

<p>
All of the display values that can be fetched and used in the gadgets UI.
These are the supported keys for the
<a href="#gadgets.skins.getProperty">gadgets.skins.getProperty()</a>
method.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="gadgets.skins.Property_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.skins.Property.ANCHOR_COLOR">ANCHOR_COLOR</a></b></code>
</dt>
<dd>The color that anchor tags should use.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.skins.Property.BG_COLOR">BG_COLOR</a></b></code>
</dt>
<dd>The color of the background of the gadget.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.skins.Property.BG_IMAGE">BG_IMAGE</a></b></code>
</dt>
<dd>An image to use in the background of the gadget.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.skins.Property.FONT_COLOR">FONT_COLOR</a></b></code>
</dt>
<dd>The color in which the main font should be rendered.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="gadgets.skins.Property_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="gadgets.skins.Property.ANCHOR_COLOR">
    <!-- -->
    </a> <h3>ANCHOR_COLOR</h3>
        <pre>&lt;static&gt; object <b>ANCHOR_COLOR</b></pre> 
    <ul>
       The color that anchor tags should use.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.skins.Property.BG_COLOR">
    <!-- -->
    </a> <h3>BG_COLOR</h3>
        <pre>&lt;static&gt; object <b>BG_COLOR</b></pre> 
    <ul>
       The color of the background of the gadget.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.skins.Property.BG_IMAGE">
    <!-- -->
    </a> <h3>BG_IMAGE</h3>
        <pre>&lt;static&gt; object <b>BG_IMAGE</b></pre> 
    <ul>
       An image to use in the background of the gadget.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.skins.Property.FONT_COLOR">
    <!-- -->
    </a> <h3>FONT_COLOR</h3>
        <pre>&lt;static&gt; object <b>FONT_COLOR</b></pre> 
    <ul>
       The color in which the main font should be rendered.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.util">Static Class gadgets.util</h1>


<!-- <i>Defined in <a href="util.src.html">util.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.util_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.util_method_detail">DETAIL</a>  
</p>

<p>
Provides general-purpose utility functions.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->

<a name="gadgets.util_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>
    
<dt><code>&lt;static&gt; 
                &nbsp;String
                
<b> <a href="#gadgets.util.escapeString">escapeString</a></b>(str) </code> 
</dt>
<dd>Escapes the input using HTML entities to make it safer.
</dd>

<dt><code>&lt;static&gt; 
                &nbsp;Object
                
<b> <a href="#gadgets.util.getFeatureParameters">getFeatureParameters</a></b>(feature) </code> 
</dt>
<dd>Returns the value of parameters for this feature.
</dd>

<dt><code>&lt;static&gt; 
                &nbsp;Boolean
                
<b> <a href="#gadgets.util.hasFeature">hasFeature</a></b>(feature) </code> 
</dt>
<dd>Returns whether the specified feature is supported.
</dd>

<dt><code>&lt;static&gt; 
<b> <a href="#gadgets.util.registerOnLoadHandler">registerOnLoadHandler</a></b>(callback) </code> 
</dt>
<dd>Registers an onload handler —
a function that's executed when the gadget loads.
</dd>

<dt><code>&lt;static&gt; 
                &nbsp;String
                
<b> <a href="#gadgets.util.unescapeString">unescapeString</a></b>(str) </code> 
</dt>
<dd>Reverses escapeString
</dd>

</dl>
&nbsp;


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<a name="gadgets.util_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="gadgets.util.escapeString"> </a> <h3>escapeString</h3>
        <pre>&lt;static&gt; String <b>escapeString</b>(str)</pre> 
    <ul>
       Escapes the input using HTML entities to make it safer.
The following characters are affected:

<ul>
<li> newline (\n, Unicode code point 10) </li>
<li> carriage return (\r, Unicode 13) </li>
<li> double quote (", Unicode 34) </li>
<li> ampersand (&amp;, Unicode 38) </li>
<li> single quote (', Unicode 39) </li>
<li> left angle bracket (&lt;, Unicode 60) </li>
<li> right angle bracket (&gt;, Unicode 62) </li>
<li> backslash (\, Unicode 92) </li>
<li> line separator (Unicode 8232) </li>
<li> paragraph separator (Unicode 8233) </li>
</ul>
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;str </code> - The string to escape 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The escaped string
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.util.getFeatureParameters"> </a> <h3>getFeatureParameters</h3>
        <pre>&lt;static&gt; Object <b>getFeatureParameters</b>(feature)</pre> 
    <ul>
       Returns the value of parameters for this feature.
A gadget specifies parameters using the
<code>&lt;Param&gt;</code> subelement of the
<code>&lt;Requires&gt;</code> or
<code>&lt;Optional&gt;</code> element.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;feature </code> - The feature to get parameters for 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Object</i>&nbsp;</code> The parameters for the given feature, or null
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.util.hasFeature"> </a> <h3>hasFeature</h3>
        <pre>&lt;static&gt; Boolean <b>hasFeature</b>(feature)</pre> 
    <ul>
       Returns whether the specified feature is supported.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;feature </code> - The feature to test for 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Boolean</i>&nbsp;</code> True if the feature is supported
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.util.registerOnLoadHandler"> </a> <h3>registerOnLoadHandler</h3>
        <pre>&lt;static&gt; <b>registerOnLoadHandler</b>(callback)</pre> 
    <ul>
       Registers an onload handler —
a function that's executed when the gadget loads.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Function</i>&nbsp;callback </code> - The handler to run 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.util.unescapeString"> </a> <h3>unescapeString</h3>
        <pre>&lt;static&gt; String <b>unescapeString</b>(str)</pre> 
    <ul>
       Reverses escapeString
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;str </code> - The string to unescape. 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The unescaped string
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.views">Static Class gadgets.views</h1>


<!-- <i>Defined in <a href="views.src.html">views.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.views_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.views_method_detail">DETAIL</a>  
</p>

<p>
Provides operations for dealing with views.

</p><p>
<b>See also: </b>
<a href="#gadgets.views.View"><code>gadgets.views.View</code></a>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->

<a name="gadgets.views_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>
    
<dt><code>&lt;static&gt; 
                &nbsp;String
                
<b> <a href="#gadgets.views.bind">bind</a></b>(urlTemplate, environment) </code> 
</dt>
<dd>Binds a URL template with variables in the passed environment
to produce a URL string.
</dd>

<dt><code>&lt;static&gt; 
                &nbsp;gadgets.views.View
                
<b> <a href="#gadgets.views.getCurrentView">getCurrentView</a></b>() </code> 
</dt>
<dd>Returns the current view.
</dd>

<dt><code>&lt;static&gt; 
                &nbsp;Map.&lt;String, String&gt;
                
<b> <a href="#gadgets.views.getParams">getParams</a></b>() </code> 
</dt>
<dd>Returns the parameters passed into this gadget for this view.
</dd>

<dt><code>&lt;static&gt; 
                &nbsp;Map&lt;gadgets.views.ViewType, String, gadgets.views.View&gt;
                
<b> <a href="#gadgets.views.getSupportedViews">getSupportedViews</a></b>() </code> 
</dt>
<dd>Returns a map of all the supported views.
</dd>

<dt><code>&lt;static&gt; 
<b> <a href="#gadgets.views.requestNavigateTo">requestNavigateTo</a></b>(view, opt_params, opt_ownerId) </code> 
</dt>
<dd>Attempts to navigate to this gadget in a different view.
</dd>

</dl>
&nbsp;


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<a name="gadgets.views_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="gadgets.views.bind"> </a> <h3>bind</h3>
        <pre>&lt;static&gt; String <b>bind</b>(urlTemplate, environment)</pre> 
    <ul>
       Binds a URL template with variables in the passed environment
to produce a URL string.

<p>
<b>See also: </b>
<a href="#gadgets.views.View.getUrlTemplate"><code>View.getUrlTemplate()</code></a>
</p>
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code>urlTemplate </code> - A url template for a container view 
        </ul>
        <ul>
            <code>environment </code> - A set of named variables 
      (for example, [OWNER | PATH | PARAMS | NAME]) of type string. 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> A URL string
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.views.getCurrentView"> </a> <h3>getCurrentView</h3>
        <pre>&lt;static&gt; gadgets.views.View <b>getCurrentView</b>()</pre> 
    <ul>
       Returns the current view.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>gadgets.views.View</i>&nbsp;</code> The current view
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.views.getParams"> </a> <h3>getParams</h3>
        <pre>&lt;static&gt; Map.&lt;String, String&gt; <b>getParams</b>()</pre> 
    <ul>
       Returns the parameters passed into this gadget for this view. Does not
include all URL parameters, only the ones passed into
gadgets.views.requestNavigateTo.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Map.&lt;String, String&gt;</i>&nbsp;</code> The parameter map
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.views.getSupportedViews"> </a> <h3>getSupportedViews</h3>
        <pre>&lt;static&gt; Map&lt;gadgets.views.ViewType, String, gadgets.views.View&gt; <b>getSupportedViews</b>()</pre> 
    <ul>
       Returns a map of all the supported views. Keys each gadgets.view.View by
its name.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Map&lt;gadgets.views.ViewType, String, gadgets.views.View&gt;</i>&nbsp;</code> All
  supported views, keyed by their name attribute.
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.views.requestNavigateTo"> </a> <h3>requestNavigateTo</h3>
        <pre>&lt;static&gt; <b>requestNavigateTo</b>(view, opt_params, opt_ownerId)</pre> 
    <ul>
       Attempts to navigate to this gadget in a different view. If the container
supports parameters will pass the optional parameters along to the gadget in
the new view.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>gadgets.views.View</i>&nbsp;view </code> - The view to navigate to 
        </ul>
        <ul>
            <code><i>Map.&lt;String, String&gt;</i>&nbsp;opt_params </code> - Parameters to pass to the
    gadget after it has been navigated to on the surface 
        </ul>
        <ul>
            <code><i>String</i>&nbsp;opt_ownerId </code> - The ID of the owner of the page to navigate to;
    defaults to the current owner 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.views.View">Class gadgets.views.View</h1>


<!-- <i>Defined in <a href="views.src.html">views.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.views.View_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.views.View_method_detail">DETAIL</a>  
</p>

<p>
Base interface for all view objects.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->

<a name="gadgets.views.View_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>
    
<dt><code>
                &nbsp;String
                
<b> <a href="#gadgets.views.View.bind">bind</a></b>(environment) </code> 
</dt>
<dd>Binds the view's URL template with variables in the passed environment
to produce a URL string.
</dd>

<dt><code>
                &nbsp;gadgets.views.ViewType, String
                
<b> <a href="#gadgets.views.View.getName">getName</a></b>() </code> 
</dt>
<dd>Returns the name of this view.
</dd>

<dt><code>
                &nbsp;String
                
<b> <a href="#gadgets.views.View.getUrlTemplate">getUrlTemplate</a></b>() </code> 
</dt>
<dd>Returns a string URI template conforming to the
<a href="http://bitworking.org/projects/URI-Templates/spec/draft-gregorio-uritemplate-03.html">
IETF spec draft</a> with variables for substitution.
</dd>

<dt><code>
                &nbsp;boolean
                
<b> <a href="#gadgets.views.View.isOnlyVisibleGadget">isOnlyVisibleGadget</a></b>() </code> 
</dt>
<dd>Returns true if the gadget is the only visible gadget in this view.
</dd>

</dl>
&nbsp;


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<a name="gadgets.views.View_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="gadgets.views.View.bind"> </a> <h3>bind</h3>
        <pre>String <b>bind</b>(environment)</pre> 
    <ul>
       Binds the view's URL template with variables in the passed environment
to produce a URL string.

<p>
<b>See also: </b>
<a href="#gadgets.views.View.getUrlTemplate"><code>getUrlTemplate()</code></a>
</p>
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code>environment </code> - A set of named variables 
      (for example, [OWNER | PATH | PARAMS | NAME]) of type string. 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> A URL string
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.views.View.getName"> </a> <h3>getName</h3>
        <pre>gadgets.views.ViewType, String <b>getName</b>()</pre> 
    <ul>
       Returns the name of this view.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>gadgets.views.ViewType, String</i>&nbsp;</code> The view name, usually specified as
a gadgets.views.ViewType
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.views.View.getUrlTemplate"> </a> <h3>getUrlTemplate</h3>
        <pre>String <b>getUrlTemplate</b>()</pre> 
    <ul>
       Returns a string URI template conforming to the
<a href="http://bitworking.org/projects/URI-Templates/spec/draft-gregorio-uritemplate-03.html">
IETF spec draft</a> with variables for substitution.
 
<p>
Four variables are supported:
</p>

<dl>
<dt>name</dt>
  <dd>The name or ID of the application</dd>
<dt>owner</dt>
  <dd>The ID of the owner of the page</dd>
<dt>path</dt>
  <dd>An array of path steps</dd>
<dt>params</dt>
  <dd>Associative array or array[param1,value1,param2,value2,...]</dd>
</dl>

<h4>Example</h4>
<p>
Here are two valid URL template strings:
</p>

<pre>http://container.com/{-list|/|name,owner,path}?{-join|&amp;|params}
http://container.com/apps/{name}/{owner}{-prefix|/|path}{-opt|?os_|params}{-join|&amp;os_|params} 
</pre>

<p>
Here are some parameters:
</p>

<pre>{ 
  name : 'Wilma',
  owner : 'Betty',
  path : ['dino','car'], 
  params = { a : 'Barney', b : 'Fred'}
}</pre>

<p>
With those parameters, the two example URL template strings
resolve to the following URLs:
</p>

<pre>http://container.com/Wilma/Betty/dino/car?a=Barney&amp;b=Fred
http://container.com/apps/Wilma/Betty/dino/car?os_a=Barney&amp;os_b=Fred
</pre>

<p>
<b>See also: </b>
<a href="#gadgets.views.View.bind"><code>bind()</code></a>
</p>
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> A template that can be used to construct URLs
    that navigate to this view
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.views.View.isOnlyVisibleGadget"> </a> <h3>isOnlyVisibleGadget</h3>
        <pre>boolean <b>isOnlyVisibleGadget</b>()</pre> 
    <ul>
       Returns true if the gadget is the only visible gadget in this view.
On a canvas page or in maximize mode this is most likely true; on a profile
page or in dashboard mode, it is most likely false.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>boolean</i>&nbsp;</code> True if the gadget is the only visible gadget; otherwise, false
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.views.ViewType">Static Class gadgets.views.ViewType</h1>


<!-- <i>Defined in <a href="views.src.html">views.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.views.ViewType_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.views.ViewType_field_detail">DETAIL</a>  
</p>

<p>
Used by <a href="#gadgets.views.View"> View</a>s.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="gadgets.views.ViewType_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.views.ViewType.CANVAS">CANVAS</a></b></code>
</dt>
<dd>A view where the gadget is displayed in a very large mode.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.views.ViewType.HOME">HOME</a></b></code>
</dt>
<dd>A view where the gadget is displayed in a small area usually on a page with
other gadgets.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.views.ViewType.PREVIEW">PREVIEW</a></b></code>
</dt>
<dd>A demo view of the gadget.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object</code>
<code><b><a href="#gadgets.views.ViewType.PROFILE">PROFILE</a></b></code>
</dt>
<dd>A view where the gadget is displayed in a small area usually on a page with
other gadgets.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="gadgets.views.ViewType_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="gadgets.views.ViewType.CANVAS">
    <!-- -->
    </a> <h3>CANVAS</h3>
        <pre>&lt;static&gt; object <b>CANVAS</b></pre> 
    <ul>
       A view where the gadget is displayed in a very large mode. It is typically
the main content on the page. The viewer is not always the same as the
owner.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.views.ViewType.HOME">
    <!-- -->
    </a> <h3>HOME</h3>
        <pre>&lt;static&gt; object <b>HOME</b></pre> 
    <ul>
       A view where the gadget is displayed in a small area usually on a page with
other gadgets. Typically the viewer is the same as the owner.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.views.ViewType.PREVIEW">
    <!-- -->
    </a> <h3>PREVIEW</h3>
        <pre>&lt;static&gt; object <b>PREVIEW</b></pre> 
    <ul>
       A demo view of the gadget. In this view the owner and viewer are not known.
    </ul>

    <!-- One single method detail entry -->
    <a name="gadgets.views.ViewType.PROFILE">
    <!-- -->
    </a> <h3>PROFILE</h3>
        <pre>&lt;static&gt; object <b>PROFILE</b></pre> 
    <ul>
       A view where the gadget is displayed in a small area usually on a page with
other gadgets. The viewer is not always the same as the owner.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="gadgets.window">Static Class gadgets.window</h1>


<!-- <i>Defined in <a href="dynamic-height.src.html">dynamic-height.js</a></i> -->

<p class="summaryDetailLink">
&nbsp;<a href="#gadgets.window_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#gadgets.window_method_detail">DETAIL</a>  
</p>

<p>
Provides operations for getting information about and modifying the
    window the gadget is placed in.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->





<!-- ========== METHOD SUMMARY =========== -->

<a name="gadgets.window_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>
    
<dt><code>&lt;static&gt; 
<b> <a href="#gadgets.window.adjustHeight">adjustHeight</a></b>(opt_height) </code> 
</dt>
<dd>Adjusts the gadget height.
</dd>

<dt><code>&lt;static&gt; 
                &nbsp;Object
                
<b> <a href="#gadgets.window.getViewportDimensions">getViewportDimensions</a></b>() </code> 
</dt>
<dd>Detects the inner dimensions of a frame.
</dd>

<dt><code>&lt;static&gt; 
<b> <a href="#gadgets.window.setTitle">setTitle</a></b>(title) </code> 
</dt> 
<dd>Sets the gadget title.
</dd> 

</dl>
&nbsp;


<!-- ========== EVENT SUMMARY =========== -->




<!-- ========== INHERITED METHODS SUMMARY =========== -->

<br>

<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->





<!-- ============ METHOD DETAIL START ======= -->

<a name="gadgets.window_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="gadgets.window.adjustHeight"> </a> <h3>adjustHeight</h3>
        <pre>&lt;static&gt; <b>adjustHeight</b>(opt_height)</pre> 
    <ul>
       Adjusts the gadget height.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Number</i>&nbsp;opt_height </code> - An optional preferred height in pixels; If not
    specified, will attempt to fit the gadget to its content 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.window.getViewportDimensions"> </a> <h3>getViewportDimensions</h3>
        <pre>&lt;static&gt; Object <b>getViewportDimensions</b>()</pre> 
    <ul>
       Detects the inner dimensions of a frame.
See <a href="http://www.quirksmode.org/dom/w3c_cssom.html">http://www.quirksmode.org/dom/w3c_cssom.html</a>
for more information.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Object</i>&nbsp;</code> An object with width and height properties
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="gadgets.window.setTitle"> </a> <h3>setTitle</h3> 
        <pre>&lt;static&gt; <b>setTitle</b>(title)</pre> 
    <ul> 
       Sets the gadget title.
    </ul> 
    
    <ul> 
        <b>Parameters:</b> 
        <ul> 
            <code><i>String</i> title </code> - The preferred title
        </ul> 
    </ul> 


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->



<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>

 <!-- outer most for loop !-->


   
      <div style="height: 28047px;" id="gc-collapsible"></div></div><!-- end gc-pagecontent -->
   </div><!-- end gooey wrapper -->

    </div> <!-- end codesite content -->

<div id="gc-footer" dir="ltr"> 
  <div class="text">
    
      <div class="notice"><div id="notice" style="text-align: center;">
  Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
  the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/2.5/">Creative Commons
  Attribution 2.5 License</a>.
<!-- <rdf:RDF xmlns="http://web.resource.org/cc/" 
              xmlns:dc="http://purl.org/dc/elements/1.1/"
              xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
  <Work rdf:about="">
    <license rdf:resource="http://creativecommons.org/licenses/by/2.5/" />
  </Work>
  <License rdf:about="http://creativecommons.org/licenses/by/2.5/">
    <permits rdf:resource="http://web.resource.org/cc/Reproduction"/>
    <permits rdf:resource="http://web.resource.org/cc/Distribution"/>
    <requires rdf:resource="http://web.resource.org/cc/Notice"/>
    <requires rdf:resource="http://web.resource.org/cc/Attribution"/>
    <permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/>
  </License>
</rdf:RDF> -->
</div>
</div>
    
    ©2008 Google -
    <a href="http://code.google.com/">Code Home</a> -
    <a href="http://www.google.com/accounts/TOS">Site Terms of Service</a> -
    <a href="http://www.google.com/privacy.html">Privacy Policy</a> -
    <a href="http://code.google.com/more/">Site Directory</a>
     <br>
     <br>
    Google Code offered in:  
    <a href="http://code.google.com/intl/zh-CN/">中文</a> - 
    <a href="http://code.google.com/">English</a> - 
    <a href="http://code.google.com/intl/pt-BR/">Português</a> - 
    <a href="http://code.google.com/intl/ru/">Pусский</a> - 
    <a href="http://code.google.com/intl/es/">Español</a> - 
    <a href="http://code.google.com/intl/ja/">日本語</a> </div><!-- end gc-footer -->
  </div>
</div><!-- end gc-containter -->
<script src="Gadgets%20API%20Reference%20-%20OpenSocial%20-%20Google%20Code1_files/ga.js" type="text/javascript">
</script>
<script type="text/javascript">
  try {
    var pageTracker = _gat._getTracker("UA-18071-1");
    pageTracker._setAllowAnchor(true);
    pageTracker._initData();
    pageTracker._trackPageview(); 
  } catch(e) {}
</script>




  <select size="6" style="position: absolute; display: none;" class="fauxSelect"><option value="zh-CN">中文 (简体)</option><option value="en">English</option><option value="pt-BR">Português (Brasil)</option><option value="ru">Pусский</option><option value="es">Español</option><option value="ja">日本語</option></select><div id="gc-collapsible-arrow"></div><div id="cs-searchresults"><div id="cs-recommended">Suggestions</div><div id="searchResult1"></div><div id="searchResult2"></div><div id="searchResult3"></div><div id="searchResult4"></div><div id="searchResult5"></div><div id="searchResult6"></div><div id="searchResult7"></div></div></body></html>